Jump to

• Request
• Response
• Examples

Get all unforecasted revenue items

get

/crmRestApi/resources/11.13.18.05/territoryForecasts/{ForecastParticipantId}/child/unforecastedPipeline

Request

Path Parameters

• ForecastParticipantId(required): integer(int64)
  The unique identifier of the participant associated with the territory forecast.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds all the revenue items that are not included in the forecast associated with a territory.
    Finder Variables:
    • RevnId; integer; The unique identifier of the revenue item.
  • RevnNumberRowFinder: Finds a revenue line with the unique public identifier.
    Finder Variables:
    • RevnNumber; string; The unique public identifier of a revenue line.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActualCloseDate; string; The date when the revenue line was closed.
  • AssetId; integer; Identifier of the asset of the opportunity.
  • BUOrgId; integer; The unique identifier of the business unit that owns the opportunity.
  • CalculatedLineRevnAmtInCorpCur; number; The opportunity revenue amount converted to the corporate currency.
  • CloseReasonCode; string; The reason for winning or losing the revenue.
  • CommitFlag; boolean; Indicates if the revenue line should be used for forecasting. If the value is True, then the revenue line should be used for forecasting. The default value is False.
  • CompetitorPartyName; string; The name of the primary competitor. For the opportunity.
  • ConflictId; integer; Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).
  • CurrStgId; integer; The unique identifier of the sales stage of the opportunity.
  • CustomerRegistryId; string; The customer registry identifier of the sales account associated with the opportunity.
  • Description; string; The user-provided description of the product associated with the revenue.
  • DownsideAmount; number; The minimum amount of revenue for the opportunity.
  • EffectiveDate; string; The date when the child revenue closes. The default value is the opportunity's close date.
  • ForecastOverrideCode; string; The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
  • LastUpdateDate; string; The date when the record was last updated.
  • Name1; string; The name of the territory.
  • OpportunityCreationDate; string; The date and time when the underlying opportunity was created.
  • OpportunityCurrencyCode; string; The currency on which the opportunity amount is based on.
  • OpportunityOwnerPartyName; string; The name of the opportunity owner.
  • OpportunityOwnerResourcePartyId; integer; The unique identifier of the opportunity owner.
  • OptyEffectiveDate; string; The estimated close date for the opportunity.
  • OptyId; integer; The unique identifier of the opportunity.
  • OptyLastUpdateDate; string; The date when the underlying opportunity was last updated.
  • OptyNumber; string; The alternate key identifier of the opportunity associated with the partner.
  • OrganizationId; integer; The unique identifier of the organization to which the product belongs.
  • OwnerPartyNumber; string; The alternate identifier of the opportunity owner.
  • PartOrgPartyName; string; The name of the primary partner associated with the child revenue.
  • PartyName2; string; Name of this party
  • PrimaryCompetitorPartyNumber; string; Primary competitor party id.
  • PrimaryContactPartyId; integer; The unique identifier of the primary contact.
  • PrimaryContactPartyName; string; The name of the primary contact.
  • PrimaryFlag; boolean; Indicates if the revenue is the primary revenue. If the value is True, then the revenue is the primary revenue among all the child revenues. The default value is False.
  • PrimaryOrganizationName; string; The name of the business unit to which this opportunity belongs.
  • PrimaryPartnerCompanyNumber; string; The alternate identifier of the primary partner.
  • ProdGroupName; string; The name of the product group associated with the revenue.
  • ProductGroupReferenceNumber; string; The product group identifier.
  • ProductType; string; The type of product on the revenue line, such as item or product group.
  • Quantity; number; The quantity of product for this opportunity.
  • RecordSet; string; The revenue category used in Revenue Line Set functionality.
  • RecurTypeCode; string; The code indicating if the line is a standard revenue line or recurring revenue line.
  • ResourcePartyId; integer; The unique identifier of the revenue owner.
  • RevnAmount; number; The amount of revenue that is earned from this opportunity.
  • RevnAmountCurcyCode; string; The code indicating the currency used to calculate the revenue for this opportunity.
  • RevnId; integer; The unique identifier of the revenue for the opportunity.
  • RevnLastUpdateDate; string; The date and time when the revenue line was last updated.
  • RevnNumber; string; The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
  • SalesChannelCd; string; The sales channel for the opportunity.
  • SalesCreditTypeCode; string; The code indicating the type of the sales credit, such as quota or non-quota.
  • SplitPercent; number; The percentage of split revenue.
  • SplitTypeCode; string; The code that indicates if the split is revenue or non-revenue.
  • StatusCd; string; The revenue status code.
  • StatusCode; string; The unique code of the status for the child revenue.
  • SumRevnDownsideAmt; number; The worst case amount.
  • SumRevnUpsideAmt; number; The best case amount.
  • SummaryRevnAmt; number; The revenue amount.
  • SummaryRevnAmtInCorpCur; number; The revenue amount converted to corporate currency.
  • TerrOwnerPartyName; string; The primary territory owner for this revenue item.
  • TerrOwnerResourceId; integer; The primary territory owner identitier for this revenue item.
  • TimeFilter; string; The time filter associated with the line.
  • UnitPrice; number; The estimated unit price for the product.
  • UpsideAmount; number; The maximum revenue amount for the opportunity.
  • WinProb; integer; The estimated probability of winning the opportunity.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : territoryForecasts-unforecastedPipeline

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/territoryForecasts-unforecastedPipeline-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object territoryForecasts-unforecastedPipeline-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/territoryForecasts-unforecastedPipeline-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : territoryForecasts-unforecastedPipeline-item-response

Type: object

Show Source

• ActualCloseDate: string (date)
  Title: Actual Close Date

  The date when the revenue line was closed.
• AmountAggregatedForScheduleFlag: boolean
  Title: Divide Amount by Transactions

  Maximum Length: 1

  The aggregated amount based on the set schedule.
• AssetId: integer (int64)
  Title: Asset

  Identifier of the asset of the opportunity.
• BUOrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit that owns the opportunity.
• CalculatedLineRevnAmtInCorpCur: number
  Title: Revenue in Corporate Currency

  Read Only: true

  The opportunity revenue amount converted to the corporate currency.
• CloseReasonCode: string
  Title: Win/Loss Reason

  Maximum Length: 30

  The reason for winning or losing the revenue.
• Comments: string
  Title: Line Comments

  Maximum Length: 250

  The user-provided comments for the revenue line.
• CommitFlag: boolean
  Title: Forecast

  Maximum Length: 1

  Indicates if the revenue line should be used for forecasting. If the value is True, then the revenue line should be used for forecasting. The default value is False.
• CompetitorPartyName: string
  Title: Competitor Party Name

  Read Only: true

  Maximum Length: 360

  The name of the primary competitor. For the opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).
• ContractEndDate: string (date-time)
  Title: Contract End Date

  The end date of the contract for the quote
• ContractStartDate: string (date-time)
  Title: Contract Start Date

  The start date of the contract for the quote
• ConversionRate: number
  Title: Conversion Rate

  The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.
• ConversionRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
• CostAmount: number
  Title: Cost

  Default Value: 0

  The cost amount for the opportunity.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the child revenue record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CreditRcptPartOrgPartyId: integer (int64)
  Title: Credit Recipient Partner

  The unique identifier of the credit recipient partner organization party.
• CrmConversionRate: number
  Title: CRM Conversion Rate

  The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.
• CrmConversionRateType: string
  Title: CRM Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
• CrmCurcyCode: string
  Title: Currency

  Maximum Length: 15

  The common CRM currency code associated with the pipeline. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrStgId: integer (int64)
  Title: Sales Stage

  Read Only: true

  The unique identifier of the sales stage of the opportunity.
• CustomerAccountId: integer (int64)
  Title: Revenue Customer Account ID

  The unique identifier of the customer account that owns the opportunity.
• CustomerRegistryId: string
  Title: Account Registry ID

  Read Only: true

  Maximum Length: 30

  The customer registry identifier of the sales account associated with the opportunity.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the forecast item has been deleted from the forecast.
• Description: string
  Title: Product

  Maximum Length: 240

  The user-provided description of the product associated with the revenue.
• Discount: number
  Title: Discount

  The discount percent.
• DownsideAmount: number
  Title: Worst Case

  Default Value: 0

  The minimum amount of revenue for the opportunity.
• EffectiveDate: string (date)
  Title: Close Date

  The date when the child revenue closes. The default value is the opportunity's close date.
• EffectiveEndDate: string (date)
  Read Only: true

  The opportunity revenue line recurrence start date.
• EffectiveStartDate: string (date)
  Read Only: true

  The opportunity revenue line recurrence end date.
• ExpectAmount: number
  Title: Expected Revenue

  Default Value: 0

  The expected amount of revenue for the opportunity.
• ExpectDlvryDate: string (date)
  Title: Expected Delivery Date

  The date when the product in the opportunity is expected to be delivered. This is used only for opportunities that include products.
• ExternalAssetKey: string
  Title: External Asset Key

  Maximum Length: 255

  The asset key from an external system.
• ExternalParentAssetKey: string
  Title: External Parent Asset Key

  Maximum Length: 255

  The root asset key of the parent from an external system.
• ExternalRootAssetKey: string
  Title: External Root Asset Key

  Maximum Length: 255

  The root asset key obtained from an external system.
• ForecastCategory: string
  Title: Forecast Category

  Maximum Length: 30

  Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.
• ForecastOverrideCode: string
  Title: Include in Forecast

  Maximum Length: 30

  The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
• InventoryItemId: integer (int64)
  Title: Product

  The unique identifier of the product in the inventory.
• InventoryOrgId: integer (int64)
  Title: Product

  The unique identifier of the organization in the inventory.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  The alternate key identifier of the product that is associated with the revenue.
• ItemNumberInternal: string
  Title: Item Number Internal

  Maximum Length: 300

  The unique internal number of the product that is associated with the revenue.
• LastUpdateDate: string (date-time)
  Title: Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MarginAmount: number
  Title: Margin

  Default Value: 0

  The margin amount for the opportunity.
• MonthlyRecurringRevenue: number
  Title: Monthly Recurring Revenue

  The monthly recurring revenue on the revenue line
• MonthlyUsageRevenue: number
  Title: Monthly Usage Revenue

  The monthly usage revenue on the revenue line
• Name1: string
  Title: Forecast Territory

  Read Only: true

  Maximum Length: 60

  The name of the territory.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  Non-Recurring Revenue Amount (Net)
• NqSplitAllocTypeCode: string
  Title: Allocation Style

  Maximum Length: 30

  The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.
• OpportunityCreationDate: string (date-time)
  Title: Opportunity Creation Date

  Read Only: true

  The date and time when the underlying opportunity was created.
• OpportunityCurrencyCode: string
  Title: Opportunity Currency

  Read Only: true

  Maximum Length: 15

  The currency on which the opportunity amount is based on.
• OpportunityOwnerPartyName: string
  Title: Opportunity Owner

  Read Only: true

  Maximum Length: 360

  The name of the opportunity owner.
• OpportunityOwnerResourcePartyId: integer (int64)
  Title: Owner

  Read Only: true

  The unique identifier of the opportunity owner.
• OpportunityPrSrcNumber: string
  Title: Primary Source

  Read Only: true

  Maximum Length: 100

  The primary marketing source or campaign that generated this opportunity.
• OptyEffectiveDate: string (date)
  Title: Opportunity Close Date

  Read Only: true

  The estimated close date for the opportunity.
• OptyId: integer (int64)
  Title: Revenue Opportunity ID

  The unique identifier of the opportunity.
• OptyLastUpdateDate: string (date-time)
  Title: Opportunity Last Update Date

  Read Only: true

  The date when the underlying opportunity was last updated.
• OptyLeadId: integer (int64)
  Title: Opportunity Lead

  The unique identifier of the lead associated with opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The alternate key identifier of the opportunity associated with the partner.
• OrganizationId: integer (int64)
  Title: Organization

  The unique identifier of the organization to which the product belongs.
• OwnerDealExpirationDate: string (date)
  Title: Effective End Date

  The date when the owner deal expires.
• OwnerDealProtectedDate: string (date)
  Title: Effective Start Date

  The date when the owner deal starts.
• OwnerLockAsgnFlag: boolean
  Title: Lock Credit Owner

  Maximum Length: 1

  Default Value: false

  Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked.
• OwnerPartyNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  The alternate identifier of the opportunity owner.
• ParentRevnId: integer (int64)
  Title: Parent Revenue ID

  The unique identifier of the parent revenue line used for Lineset functionality.
• PartEngagementTypeCd: string
  Title: Lead Registration Type

  Maximum Length: 100

  The partner engagement type.
• PartOrgPartyId: integer (int64)
  Title: Partner Organization Party ID

  Read Only: true

  The unique identifier of the primary revenue partner party.
• PartOrgPartyName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the primary partner associated with the child revenue.
• PartyName2: string
  Title: Sales Credit Recipient

  Read Only: true

  Maximum Length: 360

  Name of this party
• PrCmptPartyId: integer (int64)
  Title: Competitor

  The unique identifier of the primary competitor of the child revenue.
• PriceTypeCode: string
  Title: Price Type

  Maximum Length: 30

  The type of pricing associated with the revenue line
• PrimaryCompetitorPartyNumber: string
  Title: Primary Competitor Party Number

  Read Only: true

  Maximum Length: 30

  Primary competitor party id.
• PrimaryContactPartyId: integer (int64)
  Title: Primary Contact Party ID

  Read Only: true

  The unique identifier of the primary contact.
• PrimaryContactPartyName: string
  Title: Primary Contact

  Read Only: true

  Maximum Length: 360

  The name of the primary contact.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates if the revenue is the primary revenue. If the value is True, then the revenue is the primary revenue among all the child revenues. The default value is False.
• PrimaryOrganizationName: string
  Read Only: true

  The name of the business unit to which this opportunity belongs.
• PrimaryPartnerCompanyNumber: string
  Title: Primary Partner Number

  Maximum Length: 30

  The alternate identifier of the primary partner.
• ProdGroupId: integer (int64)
  Title: Product Group

  The unique identifier of the product group.
• ProdGroupModelConfigAttributes: string
  Title: Product Group Model Attributes

  Read Only: true

  Maximum Length: 4000

  Model Configuration Attributes associated with the Product Group in Revenue Line.
• ProdGroupModelFamily: string
  Title: Product Group Model Family

  Read Only: true

  Maximum Length: 1000

  The model family associated with the product group.
• ProdGroupModelLine: string
  Title: Product Group Model Line

  Read Only: true

  Maximum Length: 1000

  The model line associated with the product group.
• ProdGroupModelName: string
  Title: Product Group Model

  Read Only: true

  Maximum Length: 1000

  Model Name associated with the Product Group in Revenue Line.
• ProdGroupName: string
  Title: Product Group

  Maximum Length: 250

  The name of the product group associated with the revenue.
• ProdGroupQuotableFlag: boolean
  Title: Quotable

  Read Only: true

  Maximum Length: 1

  Indicates if a product group is quotable.
• ProductConfigurableFlag: boolean
  Title: Configurable Product

  Read Only: true

  Maximum Length: 1

  Indicates that a product allows configuration.
• ProductGroupReferenceNumber: string
  Title: Product Group Reference Number

  Maximum Length: 50

  The product group identifier.
• ProductModelConfigAttributes: string
  Title: Product Model Attributes

  Read Only: true

  Maximum Length: 4000

  Model Configuration Attributes associated with the Product in Revenue Line.
• ProductModelFamily: string
  Title: Product Model Family

  Read Only: true

  Maximum Length: 1000

  The model family associated with the product.
• ProductModelLine: string
  Title: Product Model Line

  Read Only: true

  Maximum Length: 1000

  The model line associated with the product.
• ProductModelName: string
  Title: Product Model

  Read Only: true

  Maximum Length: 1000

  Model Name associated with the Product in Revenue Line.
• ProductType: string
  Title: Product Type

  The type of product on the revenue line, such as item or product group.
• PrPartOrgPartyId: integer (int64)
  Title: Partner

  The unique identifier of the primary revenue partner organization party.
• PrTerritoryVersionId: integer (int64)
  Title: Forecast Territory

  The unique identifier of the primary territory for the revenue item.
• PrTerritoryVersionIdForManual: string
  Title: Manually Assigned Territory Version ID

  Indicates the version ID of a territory that is to be manually assigned to the revenue record.
• Quantity: number
  Title: Quantity

  The quantity of product for this opportunity.
• RecordSet: string
  Title: Record Set

  Read Only: true

  The revenue category used in Revenue Line Set functionality.
• RecurDownsideAmount: number
  Title: Recurring Worst Case

  The minimum revenue amount from the recurrence.
• RecurEndDate: string (date)
  Title: End By

  The date when the child revenue recurrence ends.
• RecurFrequencyCode: string
  Title: Frequency

  Maximum Length: 30

  The code that indicates the frequency of recurrence for the child revenue.
• RecurNumberPeriods: integer (int64)
  Title: End After

  The number of times the child revenue should recur.
• RecurParentRevnId: integer (int64)
  Title: Recurring Revenue Parent ID

  The unique identifier for the parent revenue of the recurring revenue lines.
• RecurPeriodOrEndDateCode: string
  Title: Recurrence Period or End Date Code

  Default Value: EndAfter

  The code indicating if a date or the number of recurrences are specified to end the recurrences.
• RecurQuantity: number
  Title: Recurring Quantity

  The quantity of the child revenue recurrence.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue amount on the revenue line
• RecurRevnAmount: number
  Title: Scheduled Revenue Amount

  The amount of revenue from the child revenue recurrence.
• RecurStartDate: string (date)
  Title: Start Date

  The date when the recurrence starts.
• RecurTypeCode: string
  Title: Recurrence Type Code

  Maximum Length: 30

  The code indicating if the line is a standard revenue line or recurring revenue line.
• RecurUnitPrice: number
  Title: Recurring Estimated Price

  The price of each child revenue recurrence.
• RecurUpsideAmount: number
  Title: Recurring Best Case

  The maximum revenue amount from the recurrence.
• ResourcePartyId: integer (int64)
  Title: Owner

  The unique identifier of the revenue owner.
• RevenueTypeCategory: string
  Title: Revenue Type Category

  Maximum Length: 30

  The Revenue category type on the opportunity revenue line.
• RevnAmount: number
  Title: Amount

  Default Value: 0

  The amount of revenue that is earned from this opportunity.
• RevnAmountCurcyCode: string
  Title: Line Currency

  Maximum Length: 15

  The code indicating the currency used to calculate the revenue for this opportunity.
• RevnCategoryCode: string
  Title: Revenue Category

  Maximum Length: 30

  The revenue category used in Revenue Line Set functionality.
• RevnCreationDate: string (date-time)
  Title: Creation Date

  functional creation date for the revenue item
• RevnId: integer (int64)
  Title: Revenue ID

  The unique identifier of the revenue for the opportunity.
• RevnLastUpdateDate: string (date-time)
  Title: Update Date

  The date and time when the revenue line was last updated.
• RevnLineTypeCode: string
  Title: Revenue Line Type Code

  Maximum Length: 30

  The code indicating the type of revenue line, such as Opportunity Summary Revenue or Standard Revenue.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
• RevnSequenceNumber: integer (int32)
  Title: Line Set

  The number indicating the sequence of the revenue in the pipeline.
• SalesAccountId: integer (int64)
  Title: Account

  The unique identifier of the opportunity sales account.
• SalesChannelCd: string
  Title: Sales Channel

  Maximum Length: 50

  The sales channel for the opportunity.
• SalesCreditTypeCode: string
  Title: Sales Credit Type

  Maximum Length: 30

  Default Value: QUOTA

  The code indicating the type of the sales credit, such as quota or non-quota.
• SalesMethodId: integer (int64)
  Title: Sales Method

  Read Only: true

  The unique identifier of the sales method.
• ScheduleAction: string
  Title: Schedule Action

  Transient attribute. Web services need to pass a value to indicate the action to be taken on Recurring Schedule - create, delete, extend, replace.
• ScheduleNonRecurringAmount: number
  Title: Nonrecurring Amount for Schedule

  The nonrecurring amount based on the set schedule.
• ScheduleRecurringAmount: number
  Title: Recurring Amount for Schedule

  The recurring amount based on the set schedule.
• ScheduleUsageAmount: number
  Title: Usage Amount for Schedule

  The usage amount based on the set schedule.
• SplitParentRevnId: integer (int64)
  Title: Split Parent Revenue ID

  The unique identifier of the split parent revenue.
• SplitPercent: number
  Title: Sales Credit

  The percentage of split revenue.
• SplitTypeCode: string
  Title: Split Type Code

  Maximum Length: 30

  The code that indicates if the split is revenue or non-revenue.
• StatusCd: string
  Title: Opportunity Status

  Read Only: true

  Maximum Length: 30

  The revenue status code.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The unique code of the status for the child revenue.
• SubscriptionId: integer (int64)
  Title: Subscription Id

  The unique identifier of the subscription.
• SubscriptionLineId: integer (int64)
  Title: Subscription Line Id

  The unique identifier of the subscription line within a subscription.
• SummaryRevnAmt: number
  Title: Opportunity Revenue

  Read Only: true

  Default Value: 0

  The revenue amount.
• SummaryRevnAmtInCorpCur: number
  Title: Opportunity Summary Revenue in Corporate Currency

  Read Only: true

  The revenue amount converted to corporate currency.
• SumRevnDownsideAmt: number
  Title: Opportunity Worst Case

  Read Only: true

  Default Value: 0

  The worst case amount.
• SumRevnUpsideAmt: number
  Title: Opportunity Best Case

  Read Only: true

  Default Value: 0

  The best case amount.
• TargetPartyId: integer (int64)
  Title: Account Party ID

  The unique identifier of the sales account that owns the opportunity.
• TerrOwnerOrganizationId: integer
  Read Only: true

  The primary territory orgnization for this revenue item.
• TerrOwnerPartyName: string
  Title: Forecast Territory Owner

  Read Only: true

  Maximum Length: 360

  The primary territory owner for this revenue item.
• TerrOwnerResourceId: integer (int64)
  Title: Resource ID

  Read Only: true

  The primary territory owner identitier for this revenue item.
• TimeFilter: string
  Title: Close Period

  Read Only: true

  The time filter associated with the line.
• TypeCode: string
  Title: Revenue Type

  Maximum Length: 30

  The revenue type for the revenue earned from the opportunity.
• UnitPrice: number
  Title: Estimated Price

  The estimated unit price for the product.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure code for the product.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the forecast item has been updated in the forecast.
• UpsideAmount: number
  Title: Best Case

  Default Value: 0

  The maximum revenue amount for the opportunity.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue amount on the revenue line
• WinProb: integer (int32)
  Title: Win Probability

  The estimated probability of winning the opportunity.

{
    "type":"object",
    "properties":{
        "ActualCloseDate":{
            "title":"Actual Close Date",
            "type":"string",
            "description":"The date when the revenue line was closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AmountAggregatedForScheduleFlag":{
            "title":"Divide Amount by Transactions",
            "maxLength":1,
            "type":"boolean",
            "description":"The aggregated amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetId":{
            "title":"Asset",
            "type":"integer",
            "description":"Identifier of the asset of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit that owns the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":18
            },
            "x-queryable":true
        },
        "CalculatedLineRevnAmtInCorpCur":{
            "title":"Revenue in Corporate Currency",
            "type":"number",
            "description":"The opportunity revenue amount converted to the corporate currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CloseReasonCode":{
            "title":"Win/Loss Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for winning or losing the revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"BUOrgId"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Line Comments",
            "maxLength":250,
            "type":"string",
            "description":"The user-provided comments for the revenue line.",
            "nullable":true,
            "x-queryable":false
        },
        "CommitFlag":{
            "title":"Forecast",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the revenue line should be used for forecasting. If the value is True, then the revenue line should be used for forecasting. The default value is False.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CompetitorPartyName":{
            "title":"Competitor Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the primary competitor. For the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractEndDate":{
            "title":"Contract End Date",
            "type":"string",
            "description":"The end date of the contract for the quote",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ContractStartDate":{
            "title":"Contract Start Date",
            "type":"string",
            "description":"The start date of the contract for the quote",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.",
            "nullable":true,
            "x-queryable":false
        },
        "CostAmount":{
            "title":"Cost",
            "type":"number",
            "description":"The cost amount for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the child revenue record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreditRcptPartOrgPartyId":{
            "title":"Credit Recipient Partner",
            "type":"integer",
            "description":"The unique identifier of the credit recipient partner organization party.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CrmConversionRate":{
            "title":"CRM Conversion Rate",
            "type":"number",
            "description":"The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.",
            "nullable":true,
            "x-queryable":false
        },
        "CrmConversionRateType":{
            "title":"CRM Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.",
            "nullable":true,
            "x-queryable":false
        },
        "CrmCurcyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The common CRM currency code associated with the pipeline. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrStgId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The unique identifier of the sales stage of the opportunity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Revenue Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account that owns the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerRegistryId":{
            "title":"Account Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The customer registry identifier of the sales account associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the forecast item has been deleted from the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Product",
            "maxLength":240,
            "type":"string",
            "description":"The user-provided description of the product associated with the revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "Discount":{
            "title":"Discount",
            "type":"number",
            "description":"The discount percent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":5,
                "scale":2,
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "DownsideAmount":{
            "title":"Worst Case",
            "type":"number",
            "description":"The minimum amount of revenue for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date when the child revenue closes. The default value is the opportunity's close date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The opportunity revenue line recurrence start date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The opportunity revenue line recurrence end date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExpectAmount":{
            "title":"Expected Revenue",
            "type":"number",
            "description":"The expected amount of revenue for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "ExpectDlvryDate":{
            "title":"Expected Delivery Date",
            "type":"string",
            "description":"The date when the product in the opportunity is expected to be delivered. This is used only for opportunities that include products.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalAssetKey":{
            "title":"External Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The asset key from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalParentAssetKey":{
            "title":"External Parent Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The root asset key of the parent from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalRootAssetKey":{
            "title":"External Root Asset Key",
            "maxLength":255,
            "type":"string",
            "description":"The root asset key obtained from an external system.",
            "nullable":true,
            "x-queryable":false
        },
        "ForecastCategory":{
            "title":"Forecast Category",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Product",
            "type":"integer",
            "description":"The unique identifier of the product in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"CRMProduct",
                "RecentItemEntityName":"CRMProduct"
            }
        },
        "InventoryOrgId":{
            "title":"Product",
            "type":"integer",
            "description":"The unique identifier of the organization in the inventory.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"The alternate key identifier of the product that is associated with the revenue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "InventoryOrgId"
                ]
            }
        },
        "ItemNumberInternal":{
            "title":"Item Number Internal",
            "maxLength":300,
            "type":"string",
            "description":"The unique internal number of the product that is associated with the revenue.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MarginAmount":{
            "title":"Margin",
            "type":"number",
            "description":"The margin amount for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "MonthlyRecurringRevenue":{
            "title":"Monthly Recurring Revenue",
            "type":"number",
            "description":"The monthly recurring revenue on the revenue line",
            "nullable":true,
            "x-queryable":false
        },
        "MonthlyUsageRevenue":{
            "title":"Monthly Usage Revenue",
            "type":"number",
            "description":"The monthly usage revenue on the revenue line",
            "nullable":true,
            "x-queryable":false
        },
        "Name1":{
            "title":"Forecast Territory",
            "maxLength":60,
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"Non-Recurring Revenue Amount (Net)",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "NqSplitAllocTypeCode":{
            "title":"Allocation Style",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OpportunityCreationDate":{
            "title":"Opportunity Creation Date",
            "type":"string",
            "description":"The date and time when the underlying opportunity was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OpportunityCurrencyCode":{
            "title":"Opportunity Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency on which the opportunity amount is based on.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "OpportunityOwnerPartyName":{
            "title":"Opportunity Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the opportunity owner.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "OpportunityOwnerResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of the opportunity owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OpportunityPrSrcNumber":{
            "title":"Primary Source",
            "maxLength":100,
            "type":"string",
            "description":"The primary marketing source or campaign that generated this opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OptyEffectiveDate":{
            "title":"Opportunity Close Date",
            "type":"string",
            "description":"The estimated close date for the opportunity.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "BETWEEN"
                ]
            },
            "x-queryable":true
        },
        "OptyId":{
            "title":"Revenue Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptyLastUpdateDate":{
            "title":"Opportunity Last Update Date",
            "type":"string",
            "description":"The date when the underlying opportunity was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyLeadId":{
            "title":"Opportunity Lead",
            "type":"integer",
            "description":"The unique identifier of the lead associated with opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the opportunity associated with the partner.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique identifier of the organization to which the product belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerDealExpirationDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date when the owner deal expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerDealProtectedDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date when the owner deal starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerLockAsgnFlag":{
            "title":"Lock Credit Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the opportunity owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentRevnId":{
            "title":"Parent Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the parent revenue line used for Lineset functionality.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartEngagementTypeCd":{
            "title":"Lead Registration Type",
            "maxLength":100,
            "type":"string",
            "description":"The partner engagement type.",
            "nullable":true,
            "x-queryable":false
        },
        "PartOrgPartyId":{
            "title":"Partner Organization Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary revenue partner party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartOrgPartyName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the primary partner associated with the child revenue.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PartyName2":{
            "title":"Sales Credit Recipient",
            "maxLength":360,
            "type":"string",
            "description":"Name of this party",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrCmptPartyId":{
            "title":"Competitor",
            "type":"integer",
            "description":"The unique identifier of the primary competitor of the child revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PrPartOrgPartyId":{
            "title":"Partner",
            "type":"integer",
            "description":"The unique identifier of the primary revenue partner organization party.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PrTerritoryVersionId":{
            "title":"Forecast Territory",
            "type":"integer",
            "description":"The unique identifier of the primary territory for the revenue item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PrTerritoryVersionIdForManual":{
            "title":"Manually Assigned Territory Version ID",
            "type":"string",
            "description":"Indicates the version ID of a territory that is to be manually assigned to the revenue record.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriceTypeCode":{
            "title":"Price Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of pricing associated with the revenue line",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryCompetitorPartyNumber":{
            "title":"Primary Competitor Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Primary competitor party id.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPartyId":{
            "title":"Primary Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the primary contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":360,
            "type":"string",
            "description":"The name of the primary contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the revenue is the primary revenue. If the value is True, then the revenue is the primary revenue among all the child revenues. The default value is False.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryOrganizationName":{
            "type":"string",
            "description":"The name of the business unit to which this opportunity belongs.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPartnerCompanyNumber":{
            "title":"Primary Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the primary partner.",
            "nullable":false,
            "x-queryable":true
        },
        "ProdGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"CRMProductGroup",
                "RecentItemEntityName":"CRMProductGroup"
            }
        },
        "ProdGroupModelConfigAttributes":{
            "title":"Product Group Model Attributes",
            "maxLength":4000,
            "type":"string",
            "description":"Model Configuration Attributes associated with the Product Group in Revenue Line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProdGroupModelFamily":{
            "title":"Product Group Model Family",
            "maxLength":1000,
            "type":"string",
            "description":"The model family associated with the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProdGroupModelLine":{
            "title":"Product Group Model Line",
            "maxLength":1000,
            "type":"string",
            "description":"The model line associated with the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProdGroupModelName":{
            "title":"Product Group Model",
            "maxLength":1000,
            "type":"string",
            "description":"Model Name associated with the Product Group in Revenue Line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProdGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group associated with the revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ProdGroupQuotableFlag":{
            "title":"Quotable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if a product group is quotable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductConfigurableFlag":{
            "title":"Configurable Product",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a product allows configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductGroupReferenceNumber":{
            "title":"Product Group Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The product group identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductModelConfigAttributes":{
            "title":"Product Model Attributes",
            "maxLength":4000,
            "type":"string",
            "description":"Model Configuration Attributes associated with the Product in Revenue Line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductModelFamily":{
            "title":"Product Model Family",
            "maxLength":1000,
            "type":"string",
            "description":"The model family associated with the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductModelLine":{
            "title":"Product Model Line",
            "maxLength":1000,
            "type":"string",
            "description":"The model line associated with the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductModelName":{
            "title":"Product Model",
            "maxLength":1000,
            "type":"string",
            "description":"Model Name associated with the Product in Revenue Line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of product on the revenue line, such as item or product group.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of product for this opportunity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            },
            "x-queryable":true
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"The revenue category used in Revenue Line Set functionality.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecurDownsideAmount":{
            "title":"Recurring Worst Case",
            "type":"number",
            "description":"The minimum revenue amount from the recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurEndDate":{
            "title":"End By",
            "type":"string",
            "description":"The date when the child revenue recurrence ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RecurFrequencyCode":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the frequency of recurrence for the child revenue.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount",
                    "NonRecurringRevenue",
                    "RecurRevenue",
                    "UsageRevenue",
                    "RevnAmount"
                ]
            }
        },
        "RecurNumberPeriods":{
            "title":"End After",
            "type":"integer",
            "description":"The number of times the child revenue should recur.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RecurParentRevnId":{
            "title":"Recurring Revenue Parent ID",
            "type":"integer",
            "description":"The unique identifier for the parent revenue of the recurring revenue lines.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RecurPeriodOrEndDateCode":{
            "title":"Recurrence Period or End Date Code",
            "type":"string",
            "description":"The code indicating if a date or the number of recurrences are specified to end the recurrences.",
            "nullable":true,
            "default":"EndAfter",
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RecurEndDate"
                ]
            }
        },
        "RecurQuantity":{
            "title":"Recurring Quantity",
            "type":"number",
            "description":"The quantity of the child revenue recurrence.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "RecurRevnAmount":{
            "title":"Scheduled Revenue Amount",
            "type":"number",
            "description":"The amount of revenue from the child revenue recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the recurrence starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RecurTypeCode":{
            "title":"Recurrence Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating if the line is a standard revenue line or recurring revenue line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecurUnitPrice":{
            "title":"Recurring Estimated Price",
            "type":"number",
            "description":"The price of each child revenue recurrence.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            }
        },
        "RecurUpsideAmount":{
            "title":"Recurring Best Case",
            "type":"number",
            "description":"The maximum revenue amount from the recurrence.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of the revenue owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueTypeCategory":{
            "title":"Revenue Type Category",
            "maxLength":30,
            "type":"string",
            "description":"The Revenue category type on the opportunity revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevnAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount of revenue that is earned from this opportunity.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "help":{
                    "instruction":"Amount"
                },
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount",
                    "NonRecurringRevenue",
                    "RecurRevenue",
                    "UsageRevenue"
                ]
            },
            "x-queryable":true
        },
        "RevnAmountCurcyCode":{
            "title":"Line Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the currency used to calculate the revenue for this opportunity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RevnCategoryCode":{
            "title":"Revenue Category",
            "maxLength":30,
            "type":"string",
            "description":"The revenue category used in Revenue Line Set functionality.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "RevnCreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"functional creation date for the revenue item",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RevnId":{
            "title":"Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the revenue for the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevnLastUpdateDate":{
            "title":"Update Date",
            "type":"string",
            "description":"The date and time when the revenue line was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RevnLineTypeCode":{
            "title":"Revenue Line Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of revenue line, such as Opportunity Summary Revenue or Standard Revenue.",
            "nullable":true,
            "x-queryable":false
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":30,
            "type":"string",
            "description":"The user-editable unique identifier for the child revenue. The default value is the revenue identifier.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RevnSequenceNumber":{
            "title":"Line Set",
            "type":"integer",
            "description":"The number indicating the sequence of the revenue in the pipeline.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SalesAccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the opportunity sales account.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SalesChannelCd":{
            "title":"Sales Channel",
            "maxLength":50,
            "type":"string",
            "description":"The sales channel for the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SalesCreditTypeCode":{
            "title":"Sales Credit Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the sales credit, such as quota or non-quota.",
            "nullable":true,
            "default":"QUOTA",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SalesMethodId":{
            "title":"Sales Method",
            "type":"integer",
            "description":"The unique identifier of the sales method.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ScheduleAction":{
            "title":"Schedule Action",
            "type":"string",
            "description":"Transient attribute.  Web services need to pass a value to indicate the action to be taken on Recurring Schedule - create, delete, extend, replace.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScheduleNonRecurringAmount":{
            "title":"Nonrecurring Amount for Schedule",
            "type":"number",
            "description":"The nonrecurring amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleRecurringAmount":{
            "title":"Recurring Amount for Schedule",
            "type":"number",
            "description":"The recurring amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleUsageAmount":{
            "title":"Usage Amount for Schedule",
            "type":"number",
            "description":"The usage amount based on the set schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "SplitParentRevnId":{
            "title":"Split Parent Revenue ID",
            "type":"integer",
            "description":"The unique identifier of the split parent revenue.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SplitPercent":{
            "title":"Sales Credit",
            "type":"number",
            "description":"The percentage of split revenue.",
            "nullable":true,
            "x-queryable":true
        },
        "SplitTypeCode":{
            "title":"Split Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates if the split is revenue or non-revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Opportunity Status",
            "maxLength":30,
            "type":"string",
            "description":"The revenue status code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The unique code of the status for the child revenue.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "AttributeType":"Picklist",
                "Dependencies":"BUOrgId"
            },
            "x-queryable":true
        },
        "SubscriptionId":{
            "title":"Subscription Id",
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubscriptionLineId":{
            "title":"Subscription Line Id",
            "type":"integer",
            "description":"The unique identifier of the subscription line within a subscription.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SumRevnDownsideAmt":{
            "title":"Opportunity Worst Case",
            "type":"number",
            "description":"The worst case amount.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "SumRevnUpsideAmt":{
            "title":"Opportunity Best Case",
            "type":"number",
            "description":"The best case amount.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "SummaryRevnAmt":{
            "title":"Opportunity Revenue",
            "type":"number",
            "description":"The revenue amount.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "SummaryRevnAmtInCorpCur":{
            "title":"Opportunity Summary Revenue in Corporate Currency",
            "type":"number",
            "description":"The revenue amount converted to corporate currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetPartyId":{
            "title":"Account Party ID",
            "type":"integer",
            "description":"The unique identifier of the sales account that owns the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TerrOwnerOrganizationId":{
            "type":"integer",
            "description":"The primary territory orgnization for this revenue item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerrOwnerPartyName":{
            "title":"Forecast Territory Owner",
            "maxLength":360,
            "type":"string",
            "description":"The primary territory owner for this revenue item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TerrOwnerResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The primary territory owner identitier for this revenue item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TimeFilter":{
            "title":"Close Period",
            "type":"string",
            "description":"The time filter associated with the line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Revenue Type",
            "maxLength":30,
            "type":"string",
            "description":"The revenue type for the revenue earned from the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "Dependencies":"BUOrgId"
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure code for the product.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId",
                    "InventoryOrgId"
                ]
            }
        },
        "UnitPrice":{
            "title":"Estimated Price",
            "type":"number",
            "description":"The estimated unit price for the product.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the forecast item has been updated in the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpsideAmount":{
            "title":"Best Case",
            "type":"number",
            "description":"The maximum revenue amount for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriceTypeCode",
                    "Quantity",
                    "RecurQuantity",
                    "UnitPrice",
                    "RecurUnitPrice",
                    "Discount"
                ]
            }
        },
        "WinProb":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The estimated probability of winning the opportunity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to get all unforecasted revenue items by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territoryForecasts/1897628/child/unforecastedPipeline?onlyData=true

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items" : [ {
    "RevnId" : 300100090407978,
    "TargetPartyId" : 999997550776400,
    "CustomerAccountId" : null,
    "BUOrgId" : 5186,
    "Comments" : null,
    "CommitFlag" : false,
    "CostAmount" : 0,
    "ResourcePartyId" : 300100027483620,
    "DownsideAmount" : 0,
    "ExpectAmount" : 12500,
    "MarginAmount" : 0,
    "OptyId" : 300100090387685,
    "UnitPrice" : null,
    "InventoryItemId" : null,
    "InventoryOrgId" : null,
    "Quantity" : 10,
    "RevnAmount" : 125000,
    "RevnAmountCurcyCode" : "USD",
    "TypeCode" : null,
    "UpsideAmount" : 125000,
    "WinProb" : 10,
    "UOMCode" : null,
    "ExpectDlvryDate" : null,
    "CreatedBy" : "ZSF_Sales_Rep3",
    "CreationDate" : "2016-07-29T14:59:21-07:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2016-09-19T01:53:42-07:00",
    "LastUpdateLogin" : "38CC162B2E17133AE05394D0F00AB723",
    "Description" : null,
    "OrganizationId" : null,
    "PrimaryFlag" : false,
    "RevnNumber" : "CDRM_99567",
    "ProdGroupId" : 999997826070652,
    "ProdGroupName" : "Agile Applications",
    "RecurFrequencyCode" : "NONE",
    "RecurEndDate" : null,
    "RecurParentRevnId" : null,
    "RecurNumberPeriods" : null,
    "RecurQuantity" : null,
    "RecurUnitPrice" : null,
    "RecurRevnAmount" : null,
    "RecurTypeCode" : "NONRECUR",
    "RecurStartDate" : null,
    "SalesCreditTypeCode" : "QUOTA",
    "SplitParentRevnId" : 300100090387706,
    "SplitPercent" : 100,
    "SplitTypeCode" : "DETAILCHILDSPLIT",
    "StatusCode" : "OPEN",
    "EffectiveDate" : "2016-10-16",
    "CloseReasonCode" : null,
    "PrCmptPartyId" : null,
    "RecurPeriodOrEndDateCode" : "EndAfter",
    "ActualCloseDate" : null,
    "PrTerritoryVersionId" : 300100026843435,
    "ConversionRate" : 1,
    "ConversionRateType" : "Corporate",
    "OwnerDealExpirationDate" : null,
    "OwnerDealProtectedDate" : null,
    "OwnerLockAsgnFlag" : false,
    "Name1" : "ZSF_Territory_USWest1",
    "ForecastOverrideCode" : "CRITERIA",
    "ItemNumber" : null,
    "ItemNumberInternal" : null,
    "ProductType" : "Group",
    "NqSplitAllocTypeCode" : null,
    "RecurDownsideAmount" : null,
    "RecurUpsideAmount" : null,
    "CrmCurcyCode" : "USD",
    "CrmConversionRateType" : "Corporate",
    "CrmConversionRate" : 1,
    "RevnCategoryCode" : null,
    "OptyLeadId" : null,
    "SalesChannelCd" : "ZPM_DIRECT_CHANNEL_TYPES",
    "PrPartOrgPartyId" : null,
    "PartEngagementTypeCd" : null,
    "CreditRcptPartOrgPartyId" : null,
    "PartOrgPartyId" : null,
    "PartOrgPartyName" : null,
    "ParentRevnId" : null,
    "RevnLineTypeCode" : "STANDARD_REVN",
    "RevnSequenceNumber" : null,
    "TerrOwnerOrganizationId" : 300100027657573,
    "EffectiveStartDate" : "2013-08-23",
    "EffectiveEndDate" : "4712-12-31",
    "SalesAccountId" : 999997550776400,
    "Discount" : null
  }, {
    "RevnId" : 300100090867466,
    "TargetPartyId" : 999997550776400,
    "CustomerAccountId" : null,
    "BUOrgId" : 5186,
    "Comments" : null,
    "CommitFlag" : false,
    "CostAmount" : 0,
    "ResourcePartyId" : 300100027483620,
    "DownsideAmount" : 0,
    "ExpectAmount" : 12500,
    "MarginAmount" : 0,
    "OptyId" : 300100090867461,
    "UnitPrice" : null,
    "InventoryItemId" : null,
    "InventoryOrgId" : null,
    "Quantity" : 10,
    "RevnAmount" : 125000,
    "RevnAmountCurcyCode" : "USD",
    "TypeCode" : null,
    "UpsideAmount" : 125000,
    "WinProb" : 10,
    "UOMCode" : null,
    "ExpectDlvryDate" : null,
    "CreatedBy" : "ZSF_Sales_Rep3",
    "CreationDate" : "2016-08-10T13:06:52-07:00",
    "LastUpdatedBy" : "SALES_ADMIN",
    "LastUpdateDate" : "2016-09-19T01:53:42-07:00",
    "LastUpdateLogin" : "39BD982CDA200C65E05394D0F00A4A4A",
    "Description" : null,
    "OrganizationId" : null,
    "PrimaryFlag" : false,
    "RevnNumber" : "CDRM_152488",
    "ProdGroupId" : 999997826070652,
    "ProdGroupName" : "Agile Applications",
    "RecurFrequencyCode" : "NONE",
    "RecurEndDate" : null,
    "RecurParentRevnId" : null,
    "RecurNumberPeriods" : null,
    "RecurQuantity" : null,
    "RecurUnitPrice" : null,
    "RecurRevnAmount" : null,
    "RecurTypeCode" : null,
    "RecurStartDate" : null,
    "SalesCreditTypeCode" : "QUOTA",
    "SplitParentRevnId" : null,
    "SplitPercent" : 100,
    "SplitTypeCode" : "NONE",
    "StatusCode" : "OPEN",
    "EffectiveDate" : "2016-10-16",
    "CloseReasonCode" : null,
    "PrCmptPartyId" : null,
    "RecurPeriodOrEndDateCode" : "EndAfter",
    "ActualCloseDate" : null,
    "PrTerritoryVersionId" : 300100026843435,
    "ConversionRate" : 1,
    "ConversionRateType" : "Corporate",
    "OwnerDealExpirationDate" : null,
    "OwnerDealProtectedDate" : null,
    "OwnerLockAsgnFlag" : false,
    "Name1" : "ZSF_Territory_USWest1",
    "ForecastOverrideCode" : "CRITERIA",
    "ItemNumber" : null,
    "ItemNumberInternal" : null,
    "ProductType" : "Group",
    "NqSplitAllocTypeCode" : "PROPORTIONAL",
    "RecurDownsideAmount" : null,
    "RecurUpsideAmount" : null,
    "CrmCurcyCode" : "USD",
    "CrmConversionRateType" : "Corporate",
    "CrmConversionRate" : 1,
    "RevnCategoryCode" : null,
    "OptyLeadId" : null,
    "SalesChannelCd" : "ZPM_DIRECT_CHANNEL_TYPES",
    "PrPartOrgPartyId" : null,
    "PartEngagementTypeCd" : null,
    "CreditRcptPartOrgPartyId" : null,
    "PartOrgPartyId" : null,
    "PartOrgPartyName" : null,
    "ParentRevnId" : null,
    "RevnLineTypeCode" : "STANDARD_REVN",
    "RevnSequenceNumber" : null,
    "TerrOwnerOrganizationId" : 300100027657573,
    "EffectiveStartDate" : "2013-08-23",
    "EffectiveEndDate" : "4712-12-31",
    "SalesAccountId" : 999997550776400,
    "Discount" : null
  }

Back to Top