Get all account rollups
get
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountRollup
Request
Path Parameters
-
PartyNumber(required): string
The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
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 an account rollup with the specified primary key.
Finder Variables:- OrganizationProfileId :The unique identifier of the organization profile.
- PrimaryKey :Finds an account rollup with the specified primary key.
-
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:- CallsMade; number; The total number of calls made to an account
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- EmailsSent; number; The total number of emails sent to an account.
- HierCallsMade; number; The total number of calls made to an account and the account's hierarchy.
- HierCurrentFiscalYearPotentialRevenueAmount; number; The cumulative total of all of the current fiscal year's potential revenue within an account hierarchy.
- HierEmailsSent; number; The total number of emails sent to an account and the account's hierarchy.
- HierEmployeesTotal; number; The count of employees, based on the account number of the employees for each account hierarchy.
- HierLastCallMadeDate; string; The date when last call was made to an account and the account's hierarchy.
- HierLastCompletedActivity; string; The date when the activity was last completed with an account and its hierarchy. Activity includes task, appointment, and call report.
- HierLastEmailSentDate; string; The date when last email was sent to an account and the account's hierarchy.
- HierLastTouchDate; string; The date when the last touch was made with an account and the account's hierarchy.
- HierNextTaskDue; string; The due date of the task with an account and its hierarchy.
- HierNumberOfOpenActivities; number; The count of activities that are open within an account hierarchy.
- HierNumberOfOpenCriticalServiceRequests; number; The number of open service requests within an account hierarchy, where the severity is one.
- HierNumberOfOpenHotLeads; number; The hierarchy count of leads that are open with Hot rank.
- HierNumberOfOpenLeads; number; The count of leads that are in Open status within an account hierarchy.
- HierNumberOfOpenOpportunities; number; The count of opportunities that are open within an account hierarchy.
- HierNumberOfOpenServiceRequests; number; The number of open Service Requests for the account hierarchy.
- HierNumberOfTouches; number; The total number of touches with an account and the account's hierarchy. A touch refers to an outbound communication such as email, phone and so on.
- HierSumOfActiveSubscriptionsMRR; number; The cumulative monthly recurring revenue from active subscription lines on an account and its hierarchy.
- HierSumOfActiveSubscriptionsTCV; number; The cumulative total contract value amounts from active subscription lines on an account and its hierarchy.
- HierSumOfClosedSubscriptionsMRR; number; The cumulative monthly recurring revenue from subscription lines on an account and its hierarchy that were closed in a given period of time.
- HierSumOfLapsedRenewalsMRR; number; The cumulative monthly recurring revenue from expired subscription lines on an account and its hierarchy that don't have renewal lines.
- HierSumOfOpenLeadAmount; number; The sum of the potential revenues from qualified and unqualified open leads of an account and the account's hierarchy.
- HierSumOfOpenOpportunitiesRevenue; number; The cumulative total of open opportunity potential revenue amount within the account hierarchy.
- HierSumOfOpenOrderAmount; number; The cumulative total of quote and order amount within the account hierarchy, where status is Open or Processing.
- HierSumOfUpcomingRenewalsMRR; number; The cumulative monthly recurring revenue from expiring subscription lines on an account and its hierarchy that haven't been amended, closed, suspended, or renewed.
- HierSumOfWonOpportunitiesRevenue; number; The cumulative total of potential revenue amount from Won opportunities, within the account hierarchy.
- HierSumOfWonOrderAmount; number; The total of orders within an Account Hierarchy, where the status is Closed.
- HierTotalCompletedActivities; number; The total number of completed activities with an account and its hierarchy.
- LastCallMadeDate; string; The date when last call was made to an account.
- LastCompletedActivity; string; The date when the activity was last completed with an account. Activity includes task, appointment, and call report.
- LastEmailSentDate; string; The date when last email was sent to an account.
- LastTouchDate; string; The date when last email was sent to an account.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- NextTaskDue; string; The due date of the task with an account.
- NumberOfOpenActivities; number; The count of activities that are open within an account.
- NumberOfOpenCriticalServiceRequests; number; The number of open Service Requests for the account that are Severity equal to one.
- NumberOfOpenHotLeads; number; The count of leads that are open with Hot rank.
- NumberOfOpenLeads; number; The count of Leads that are Open on the Account.
- NumberOfOpenOpportunities; number; The count on open opportunities within an Account.
- NumberOfOpenServiceRequests; number; The number of open Service Requests for the account.
- NumberOfTouches; number; The total number of touches with an account. A touch refers to an outbound communication such as email, phone and so on.
- OrganizationProfileId; integer; The unique identifier of the organization profile.
- SumOfActiveSubscriptionsMRR; number; The cumulative monthly recurring revenue from active subscription lines on an account.
- SumOfActiveSubscriptionsTCV; number; The cumulative total contract value amounts from active subscription lines on an account.
- SumOfClosedSubscriptionsMRR; number; The cumulative monthly recurring revenue from subscription lines on an account that were closed in a given period of time.
- SumOfLapsedRenewalsMRR; number; The cumulative monthly recurring revenue from expired subscription lines on an account that don't have renewal lines.
- SumOfOpenLeadAmount; number; The sum of the potential revenues from qualified and unqualified open leads of an account.
- SumOfOpenOpportunitiesRevenue; number; The cumulative total of open opportunity potential revenue amount for the account.
- SumOfOpenOrderAmount; number; The cumulative total of quote and order amount for the account where status is Open or Processing.
- SumOfUpcomingRenewalsMRR; number; The cumulative monthly recurring revenue from expiring subscription lines on an account that haven't been amended, closed, suspended, or renewed.
- SumOfWonOpportunitiesRevenue; number; The cumulative total of won opportunity potential revenue amount for the account.
- SumOfWonOrderAmount; number; The cumulative total of order amount for the orders where status is Closed.
- TotalCompletedActivities; number; The total number of completed activities with an account.
-
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:
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.
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(required):
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(required):
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 : accounts-AccountRollup
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-AccountRollup-item-response
Type:
Show Source
object
-
CallsMade: number
Title:
Number of Calls Made
Read Only:true
The total number of calls made to an account -
CorpCurrencyCode: string
Title:
Corporate Currency
Read Only:true
Maximum Length:15
The corporate currency code associated with the account rollup such as USD or INR. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EmailsSent: number
Title:
Number of Emails Sent
Read Only:true
The total number of emails sent to an account. -
HierCallsMade: number
Title:
Hierarchy Number of Calls Made
Read Only:true
The total number of calls made to an account and the account's hierarchy. -
HierCurrentFiscalYearPotentialRevenueAmount: number
Title:
Hierarchy Current Fiscal Year's Potential Revenue
Read Only:true
The cumulative total of all of the current fiscal year's potential revenue within an account hierarchy. -
HierEmailsSent: number
Title:
Hierarchy Number of Emails Sent
Read Only:true
The total number of emails sent to an account and the account's hierarchy. -
HierEmployeesTotal: number
Title:
Hierarchy Total Number of Employees
Read Only:true
The count of employees, based on the account number of the employees for each account hierarchy. -
HierLastCallMadeDate: string
(date-time)
Title:
Hierarchy Last Call Made
Read Only:true
The date when last call was made to an account and the account's hierarchy. -
HierLastCompletedActivity: string
(date-time)
Title:
Hierarchy Last Completed Activity
Read Only:true
The date when the activity was last completed with an account and its hierarchy. Activity includes task, appointment, and call report. -
HierLastEmailSentDate: string
(date-time)
Title:
Hierarchy Last Email Sent
Read Only:true
The date when last email was sent to an account and the account's hierarchy. -
HierLastTouchDate: string
(date-time)
Title:
Hierarchy Last Touch
Read Only:true
The date when the last touch was made with an account and the account's hierarchy. -
HierNextTaskDue: string
(date)
Title:
Hierarchy Next Task Due
Read Only:true
The due date of the task with an account and its hierarchy. -
HierNumberOfOpenActivities: number
Title:
Hierarchy Number of Open Activities
Read Only:true
The count of activities that are open within an account hierarchy. -
HierNumberOfOpenCriticalServiceRequests: number
Title:
Hierarchy Number of Open Critical Service Requests
Read Only:true
The number of open service requests within an account hierarchy, where the severity is one. -
HierNumberOfOpenHotLeads: number
Title:
Hierarchy Number of Open Hot Leads
Read Only:true
The hierarchy count of leads that are open with Hot rank. -
HierNumberOfOpenLeads: number
Title:
Hierarchy Number of Open Leads
Read Only:true
The count of leads that are in Open status within an account hierarchy. -
HierNumberOfOpenOpportunities: number
Title:
Hierarchy Number of Open Opportunities
Read Only:true
The count of opportunities that are open within an account hierarchy. -
HierNumberOfOpenServiceRequests: number
Title:
Hierarchy Number of Open Service Requests
Read Only:true
The number of open Service Requests for the account hierarchy. -
HierNumberOfTouches: number
Title:
Hierarchy Number of Touches
Read Only:true
The total number of touches with an account and the account's hierarchy. A touch refers to an outbound communication such as email, phone and so on. -
HierSumOfActiveSubscriptionsMRR: number
Title:
Hierarchy Active Subscriptions MRR Amount
Read Only:true
The cumulative monthly recurring revenue from active subscription lines on an account and its hierarchy. -
HierSumOfActiveSubscriptionsTCV: number
Title:
Hierarchy Active Subscriptions TCV Amount
Read Only:true
The cumulative total contract value amounts from active subscription lines on an account and its hierarchy. -
HierSumOfClosedSubscriptionsMRR: number
Title:
Hierarchy Closed Subscriptions MRR Amount
Read Only:true
The cumulative monthly recurring revenue from subscription lines on an account and its hierarchy that were closed in a given period of time. -
HierSumOfLapsedRenewalsMRR: number
Title:
Hierarchy Lapsed Renewals MRR Amount
Read Only:true
The cumulative monthly recurring revenue from expired subscription lines on an account and its hierarchy that don't have renewal lines. -
HierSumOfOpenLeadAmount: number
Title:
Hierarchy Total Potential Revenue from Open Leads
Read Only:true
The sum of the potential revenues from qualified and unqualified open leads of an account and the account's hierarchy. -
HierSumOfOpenOpportunitiesRevenue: number
Title:
Hierarchy Open Opportunity Revenue
Read Only:true
The cumulative total of open opportunity potential revenue amount within the account hierarchy. -
HierSumOfOpenOrderAmount: number
Title:
Hierarchy Open Order Amount
Read Only:true
The cumulative total of quote and order amount within the account hierarchy, where status is Open or Processing. -
HierSumOfUpcomingRenewalsMRR: number
Title:
Hierarchy Upcoming Renewals MRR Amount
Read Only:true
The cumulative monthly recurring revenue from expiring subscription lines on an account and its hierarchy that haven't been amended, closed, suspended, or renewed. -
HierSumOfWonOpportunitiesRevenue: number
Title:
Hierarchy Won Opportunity Revenue
Read Only:true
The cumulative total of potential revenue amount from Won opportunities, within the account hierarchy. -
HierSumOfWonOrderAmount: number
Title:
Hierarchy Won Order Amount
Read Only:true
The total of orders within an Account Hierarchy, where the status is Closed. -
HierTotalCompletedActivities: number
Title:
Hierarchy Total Completed Activities
Read Only:true
The total number of completed activities with an account and its hierarchy. -
LastCallMadeDate: string
(date-time)
Title:
Last Call Made On
Read Only:true
The date when last call was made to an account. -
LastCompletedActivity: string
(date-time)
Title:
Last Completed Activity
Read Only:true
The date when the activity was last completed with an account. Activity includes task, appointment, and call report. -
LastEmailSentDate: string
(date-time)
Title:
Last Email Sent
Read Only:true
The date when last email was sent to an account. -
LastTouchDate: string
(date-time)
Title:
Last Touch
Read Only:true
The date when last email was sent to an account. -
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 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. -
NextTaskDue: string
(date)
Title:
Next Task Due
Read Only:true
The due date of the task with an account. -
NumberOfOpenActivities: number
Title:
Number of Open Activities
Read Only:true
The count of activities that are open within an account. -
NumberOfOpenCriticalServiceRequests: number
Title:
Number of Open Critical Service Requests
Read Only:true
The number of open Service Requests for the account that are Severity equal to one. -
NumberOfOpenHotLeads: number
Title:
Number of Open Hot Leads
Read Only:true
The count of leads that are open with Hot rank. -
NumberOfOpenLeads: number
Title:
Number of Open Leads
Read Only:true
The count of Leads that are Open on the Account. -
NumberOfOpenOpportunities: number
Title:
Number of Open Opportunities
Read Only:true
The count on open opportunities within an Account. -
NumberOfOpenServiceRequests: number
Title:
Number of Open Service Requests
Read Only:true
The number of open Service Requests for the account. -
NumberOfTouches: number
Title:
Number of Touches
Read Only:true
The total number of touches with an account. A touch refers to an outbound communication such as email, phone and so on. -
OrganizationProfileId: integer
(int64)
Title:
Organization Profile Identifier
Read Only:true
The unique identifier of the organization profile. -
SumOfActiveSubscriptionsMRR: number
Title:
Active Subscriptions MRR Amount
Read Only:true
The cumulative monthly recurring revenue from active subscription lines on an account. -
SumOfActiveSubscriptionsTCV: number
Title:
Active Subscriptions TCV Amount
Read Only:true
The cumulative total contract value amounts from active subscription lines on an account. -
SumOfClosedSubscriptionsMRR: number
Title:
Closed Subscriptions MRR Amount
Read Only:true
The cumulative monthly recurring revenue from subscription lines on an account that were closed in a given period of time. -
SumOfLapsedRenewalsMRR: number
Title:
Lapsed Renewals MRR Amount
Read Only:true
The cumulative monthly recurring revenue from expired subscription lines on an account that don't have renewal lines. -
SumOfOpenLeadAmount: number
Title:
Total Potential Revenue from Open Leads
Read Only:true
The sum of the potential revenues from qualified and unqualified open leads of an account. -
SumOfOpenOpportunitiesRevenue: number
Title:
Open Opportunity Revenue
Read Only:true
The cumulative total of open opportunity potential revenue amount for the account. -
SumOfOpenOrderAmount: number
Title:
Open Order Amount
Read Only:true
The cumulative total of quote and order amount for the account where status is Open or Processing. -
SumOfUpcomingRenewalsMRR: number
Title:
Upcoming Renewals MRR Amount
Read Only:true
The cumulative monthly recurring revenue from expiring subscription lines on an account that haven't been amended, closed, suspended, or renewed. -
SumOfWonOpportunitiesRevenue: number
Title:
Won Opportunity Revenue
Read Only:true
The cumulative total of won opportunity potential revenue amount for the account. -
SumOfWonOrderAmount: number
Title:
Won Order Amount
Read Only:true
The cumulative total of order amount for the orders where status is Closed. -
TotalCompletedActivities: number
Title:
Total Completed Activities
Read Only:true
The total number of completed activities with an account.
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.