Get all partner rollups
get
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/partnerRollup/{PartyId}
Request
Path Parameters
-
CompanyNumber(required): string
The alternate key identifier of the partner's company.
-
PartyId(required): integer(int64)
The unique identifier of the partner associated with the partner rollup.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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.
Root Schema : partners-partnerRollup-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.