Jump to

• Request
• Response

Get a partner rollup

get

/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/partnerRollup

Request

Path Parameters

• CompanyNumber(required): string
  The alternate key identifier of the partner's company.

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: Find a partner rollup with a primary key.
    Finder Variables:
    • PartyId; integer; The party identifier passed as a parameter to the finder service.
• 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:
  

  • CreatedBy; string; The user who created the row.
  • CreationDate; string; The date and time when the row was created.
  • DealConvToOpty; number; The count of the deal registrations converted to opportunities in current fiscal year.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdateLogin; string; The user who last updated the opportunity record.
  • LastUpdatedBy; string; The session login associated to the user who last updated the record.
  • NumberOfApprvClaim; number; Count of the MDF Claims of a Partner that are approved.
  • NumberOfOpenMdfClaim; number; Count of the open MDF Claims pending for approval of a Partner.
  • NumberOfOpenMdfRequest; number; Count of the open MDF Requests of a Partner.
  • NumberOfOpenOpty; number; Count of open opportunities of a partner.
  • NumberOfPendApprEnrol; number; Count of Enrollments that are pending for approval of a Partner.
  • OpenOptyRevenueAmount; number; Sum of the potential revenue from open opportunities of a partner.
  • PartyId; integer; The unique identifier of the partner associated with the partner rollup.
  • SumApprvClaimAmount; number; Sum of the MDF Claims amount that are approved of a Partner.
  • SumOpenMdfClaimAmount; number; Sum of the open MDF Claims amount pending for approval of a Partner.
  • SumOpenMdfRequestAmount; number; Sum of the open MDF Requests amount of a Partner.
  • SumOpenOptyRevenueNxtQtr; number; Total revenue of a Partner from open opportunities with expected close date falling in the next quarter.
  • SumOpenOptyRevenueThisQtr; number; Total revenue of a Partner from open opportunities with expected close date falling in the current quarter.
  • SumOptyRevenueWonThisQtr; number; Total revenue of partner from won opportunities with expected close date falling in the current quarter.
  • UserLastUpdateDate; string; The date on which the record is last updated by user.
  • WonOptyRevenueAmount; number; Sum of the revenue from won opportunities of a partner.
• 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 : partners-partnerRollup

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/partners-partnerRollup-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object partners-partnerRollup-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/partners-partnerRollup-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 : partners-partnerRollup-item-response

Type: object

Show Source

• CorpCurrencyCode: string
  Title: Corporate Currency

  Read Only: true

  Maximum Length: 15

  The currency code associated with the Partner. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the row was created.
• DealConvToOpty: number
  Title: Converted Deals

  Read Only: true

  The count of the deal registrations converted to opportunities in current fiscal year.
• HierNumberOfApprvClaim: number
  Title: Hierarchy Approved MDF Claims

  Read Only: true

  Count of the MDF Claims that are approved of a Partner and it's hierarchies.
• HierNumberOfOpenMdfClaim: number
  Title: Hierarchy Open MDF Claims

  Read Only: true

  Count of the open MDF Claims pending for approval of a Partner and it's hierarchies.
• HierNumberOfOpenMdfRequest: number
  Title: Hierarchy Open MDF Requests

  Read Only: true

  Count of the open MDF Requests of a Partner and it's hierarchies .
• HierNumberOfOpenOpty: number
  Title: Hierarchy Open Opportunities

  Read Only: true

  Count of open Opportunities of a partner and its hierarchies.
• HierNumberOfPendApprEnrol: number
  Title: Hierarchy Enrollments Pending Approval

  Read Only: true

  Count of Enrollments that are pending for approval of a Partner and it's hierarchies.
• HierOpenOptyRevenueAmount: number
  Title: Hierarchy Open Opportunity Revenue

  Read Only: true

  Sum of the potential revenue from open opportunities of a partner and it's hierarchies.
• HierSumApprvClaimAmount: number
  Title: Hierarchy Approved MDF Claims Amount

  Read Only: true

  Sum of the MDF Claims amount that are approved of a Partner and it's hierarchies .
• HierSumOpenMdfClaimAmount: number
  Title: Hierarchy Open MDF Claims Amount

  Read Only: true

  Sum of the open MDF Claims amount pending for approval of a Partner and it's hierarchies.
• HierSumOpenMdfRequestAmount: number
  Title: Hierarchy Open MDF Requests Amount

  Read Only: true

  Sum of the open MDF Requests amount of a Partner and it's hierarchies.
• HierSumOpenOptyRevenueNxtQtr: number
  Title: Hierarchy Total Open Opportunities Revenue for Next Quarter

  Read Only: true

  Total revenue of a Partner and its hierarchies from open opportunities with expected close date falling in the next quarter.
• HierSumOpenOptyRevenueQtr: number
  Title: Hierarchy Total Open Opportunities Revenue in Current Quarter

  Read Only: true

  Total revenue of a Partner and its hierarchies from open opportunities with expected close date falling in the current quarter.
• HierSumOptyRevenueWonQtr: number
  Title: Hierarchy Total Won Opportunities Revenue in Current Quarter

  Read Only: true

  The total revenue of a partner and its hierarchies from won opportunities with expected close date falling in the current quarter.
• HierUsedApprovedBudgetAmount: number
  Title: Hierarchy MDF Utilization

  Read Only: true

  User Approved Budget Amount of a partner or its hierarchies .
• HierWonOptyRevenueAmount: number
  Title: Hierarchy Won Opportunities Revenue

  Read Only: true

  Sum of the revenue from won opportunities of a partner and it's hierarchies.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• NumberOfApprvClaim: number
  Title: Approved MDF Claims

  Read Only: true

  Count of the MDF Claims of a Partner that are approved.
• NumberOfOpenMdfClaim: number
  Title: Open MDF Claims

  Read Only: true

  Count of the open MDF Claims pending for approval of a Partner.
• NumberOfOpenMdfRequest: number
  Title: Open MDF Requests

  Read Only: true

  Count of the open MDF Requests of a Partner.
• NumberOfOpenOpty: number
  Title: Open Opportunities

  Read Only: true

  Count of open opportunities of a partner.
• NumberOfPendApprEnrol: number
  Title: Enrollments Pending Approval

  Read Only: true

  Count of Enrollments that are pending for approval of a Partner.
• OpenOptyRevenueAmount: number
  Title: Potential Opportunity Revenue

  Read Only: true

  Sum of the potential revenue from open opportunities of a partner.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the partner associated with the partner rollup.
• SumApprvClaimAmount: number
  Title: Approved MDF Claims Amount

  Read Only: true

  Sum of the MDF Claims amount that are approved of a Partner.
• SumOpenMdfClaimAmount: number
  Title: Open MDF Claims Amount

  Read Only: true

  Sum of the open MDF Claims amount pending for approval of a Partner.
• SumOpenMdfRequestAmount: number
  Title: Open MDF Requests Amount

  Read Only: true

  Sum of the open MDF Requests amount of a Partner.
• SumOpenOptyRevenueNxtQtr: number
  Title: Total Open Opportunities Revenue for Next Quarter

  Read Only: true

  Total revenue of a Partner from open opportunities with expected close date falling in the next quarter.
• SumOpenOptyRevenueThisQtr: number
  Title: Total Open Opportunities Revenue in Current Quarter

  Read Only: true

  Total revenue of a Partner from open opportunities with expected close date falling in the current quarter.
• SumOptyRevenueWonThisQtr: number
  Title: Total Won Opportunities Revenue in Current Quarter

  Read Only: true

  Total revenue of partner from won opportunities with expected close date falling in the current quarter.
• UsedApprovedBudgetAmount: number
  Title: MDF Utilization

  Read Only: true

  The budget approved by the user.
• UserLastUpdateDate: string (date-time)
  Read Only: true

  The date on which the record is last updated by user.
• WonOptyRevenueAmount: number
  Title: Won Opportunities Revenue

  Read Only: true

  Sum of the revenue from won opportunities of a partner.

{
    "type":"object",
    "properties":{
        "HierOpenOptyRevenueAmount":{
            "title":"Hierarchy Open Opportunity Revenue",
            "type":"number",
            "description":"Sum of the potential revenue from open opportunities of a partner and it's hierarchies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the potential revenue from open opportunities of a partner and it's hierarchies.",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the date of the creation of the row."
            },
            "x-queryable":true
        },
        "SumOpenOptyRevenueNxtQtr":{
            "title":"Total Open Opportunities Revenue for Next Quarter",
            "type":"number",
            "description":"Total revenue of a Partner from open opportunities with expected close date falling in the next quarter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Total revenue of a Partner from open opportunities with expected close date falling in the next quarter.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierSumOpenOptyRevenueNxtQtr":{
            "title":"Hierarchy Total Open Opportunities Revenue for Next Quarter",
            "type":"number",
            "description":"Total revenue of a Partner and its hierarchies from open opportunities with expected close date falling in the next quarter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Total revenue of a Partner and its hierarchies from open opportunities with expected close date falling in the next quarter.",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "DealConvToOpty":{
            "title":"Converted Deals",
            "type":"number",
            "description":"The count of the deal registrations converted to opportunities in current fiscal year.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"The count of the deal registrations converted to opportunities in current fiscal year."
            },
            "x-queryable":true
        },
        "HierUsedApprovedBudgetAmount":{
            "title":"Hierarchy MDF Utilization",
            "type":"number",
            "description":"User Approved Budget Amount of a partner or its hierarchies .",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"User Approved Budget Amount of a partner or its hierarchies .",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "HierSumApprvClaimAmount":{
            "title":"Hierarchy Approved MDF Claims Amount",
            "type":"number",
            "description":"Sum of the MDF Claims amount that are approved of a Partner and it's hierarchies .",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the MDF Claims amount that are approved of a Partner and it's hierarchies .",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"The date on which the record is last updated by user.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SumOpenMdfClaimAmount":{
            "title":"Open MDF Claims Amount",
            "type":"number",
            "description":"Sum of the open MDF Claims amount pending for approval of a Partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the open MDF Claims amount pending for approval of a Partner.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "NumberOfPendApprEnrol":{
            "title":"Enrollments Pending Approval",
            "type":"number",
            "description":"Count of Enrollments that are pending for approval of a Partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of Enrollments that are pending for approval of a Partner."
            },
            "x-queryable":true
        },
        "HierNumberOfApprvClaim":{
            "title":"Hierarchy Approved MDF Claims",
            "type":"number",
            "description":"Count of the MDF Claims that are approved of a Partner and it's hierarchies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of the MDF Claims that are approved of a Partner and it's hierarchies"
            }
        },
        "NumberOfApprvClaim":{
            "title":"Approved MDF Claims",
            "type":"number",
            "description":"Count of the MDF Claims of a Partner that are approved.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of the MDF Claims of a Partner that are approved."
            },
            "x-queryable":true
        },
        "HierSumOpenOptyRevenueQtr":{
            "title":"Hierarchy Total Open Opportunities Revenue in Current Quarter",
            "type":"number",
            "description":"Total revenue of a Partner and its hierarchies from open opportunities with expected close date falling in the current quarter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Total revenue of a Partner and its hierarchies from open opportunities with expected close date falling in the current quarter.",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "SumApprvClaimAmount":{
            "title":"Approved MDF Claims Amount",
            "type":"number",
            "description":"Sum of the MDF Claims amount  that are approved of a Partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the MDF Claims amount  that are approved of a Partner.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierSumOpenMdfRequestAmount":{
            "title":"Hierarchy Open MDF Requests Amount",
            "type":"number",
            "description":"Sum of the open MDF Requests amount of a Partner and it's hierarchies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the open MDF Requests amount of a Partner and it's hierarchies. ",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "NumberOfOpenMdfRequest":{
            "title":"Open MDF Requests",
            "type":"number",
            "description":"Count of the open MDF Requests of a Partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of the open MDF Requests of a Partner."
            },
            "x-queryable":true
        },
        "SumOpenOptyRevenueThisQtr":{
            "title":"Total Open Opportunities Revenue in Current Quarter",
            "type":"number",
            "description":"Total revenue of a Partner from open opportunities with expected close date falling in the current quarter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Total revenue of a Partner from open opportunities with expected close date falling in the current quarter.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierNumberOfOpenOpty":{
            "title":"Hierarchy Open Opportunities",
            "type":"number",
            "description":"Count of open Opportunities of a partner and its hierarchies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of open Opportunities of a partner and its hierarchies."
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OpenOptyRevenueAmount":{
            "title":"Potential Opportunity Revenue",
            "type":"number",
            "description":"Sum of the potential revenue from open opportunities of a partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "description":"Sum of the potential revenue from open opportunities of a partner.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the Partner. A list of accepted values is defined in the lookup\nZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "description":"The currency code associated with the Partner. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task."
            }
        },
        "UsedApprovedBudgetAmount":{
            "title":"MDF Utilization",
            "type":"number",
            "description":"The budget approved by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"The budget approved by the user.",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the user who last updated the row."
            },
            "x-queryable":true
        },
        "NumberOfOpenOpty":{
            "title":"Open Opportunities",
            "type":"number",
            "description":"Count of open opportunities of a partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of open opportunities of a partner."
            },
            "x-queryable":true
        },
        "NumberOfOpenMdfClaim":{
            "title":"Open MDF Claims",
            "type":"number",
            "description":"Count of the open MDF Claims pending for approval of a Partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of the open MDF Claims pending for approval of a Partner."
            },
            "x-queryable":true
        },
        "HierNumberOfPendApprEnrol":{
            "title":"Hierarchy Enrollments Pending Approval",
            "type":"number",
            "description":"Count of Enrollments that are pending for approval of a Partner and it's hierarchies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of Enrollments that are pending for approval of a Partner and it's hierarchies."
            }
        },
        "HierSumOpenMdfClaimAmount":{
            "title":"Hierarchy Open MDF Claims Amount",
            "type":"number",
            "description":"Sum of the open MDF Claims amount pending for approval of a Partner and it's hierarchies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the open MDF Claims amount pending for approval of a Partner and it's hierarchies.",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the user who created the row."
            },
            "x-queryable":true
        },
        "HierSumOptyRevenueWonQtr":{
            "title":"Hierarchy Total Won Opportunities Revenue in Current Quarter",
            "type":"number",
            "description":"The total revenue of a partner and its hierarchies from won opportunities with expected close date falling in the current quarter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"The total revenue of a partner and its hierarchies from won opportunities with expected close date falling in the current quarter.",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "HierNumberOfOpenMdfRequest":{
            "title":"Hierarchy Open MDF Requests",
            "type":"number",
            "description":"Count of the open MDF Requests of a Partner and it's hierarchies .",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of the open MDF Requests of a Partner and it's hierarchies ."
            }
        },
        "HierWonOptyRevenueAmount":{
            "title":"Hierarchy Won Opportunities Revenue",
            "type":"number",
            "description":"Sum of the revenue from won opportunities of a partner and it's hierarchies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the revenue from won opportunities of a partner and it's hierarchies.",
                "objCurrencyCode":"CorpCurrencyCode"
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the partner associated with the partner rollup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SumOpenMdfRequestAmount":{
            "title":"Open MDF Requests Amount",
            "type":"number",
            "description":"Sum of the open MDF Requests amount  of a Partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the open MDF Requests amount  of a Partner.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "HierNumberOfOpenMdfClaim":{
            "title":"Hierarchy Open MDF Claims",
            "type":"number",
            "description":"Count of the open MDF Claims pending for approval of a Partner and it's hierarchies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Count of the open MDF Claims pending for approval of a Partner and it's hierarchies"
            }
        },
        "WonOptyRevenueAmount":{
            "title":"Won Opportunities Revenue",
            "type":"number",
            "description":"Sum of the revenue from won opportunities of a partner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Sum of the revenue from won opportunities of a partner.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "SumOptyRevenueWonThisQtr":{
            "title":"Total Won Opportunities Revenue in Current Quarter",
            "type":"number",
            "description":"Total revenue of partner from won opportunities with expected close date falling in the current quarter.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "description":"Total revenue of partner from won opportunities with expected close date falling in the current quarter.",
                "objCurrencyCode":"CorpCurrencyCode"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the user who last updated the row."
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The user who last updated the opportunity record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "description":"Who column: indicates the session login associated to the user who last updated the row."
            },
            "x-queryable":true
        }
    }
}

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