1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Accounts
  4. Account Rollups

Get all account rollups

get

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountRollup

Request

Path Parameters
  • 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. Inactive records can't be updated.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
    • DateLastLeadCreated; string; Last Creation Date of Qualified Lead
    • DateNextOptyClosed; string; Next Opportunity Closing Date
    • 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.
    • HierDateLastLeadCreated; string; The date when the last lead was created in account hierarchy.
    • HierDateNextOptyClosed; string; The date when the next opportunity is expected to close in 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.
    • HierNumberOfDecMakerContacts; number; The number of contacts, and its hierarchy, with buying role of either decision maker or secondary decision maker.
    • 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.
    • HierNumberOfQualHotLeads; number; The number of leads, and its hierarchy, that are qualified and hot.
    • HierNumberOfQualifiedLeads; number; The number of leads, and its hierarchy, that are qualified.
    • HierNumberOfSrClosePastWeek; number; The number of service requests with close date falling in the past seven days and its hierarchy.
    • HierNumberOfSubsExpNxtQtr; number; The count of subscription products, and it hierarchy, that are expiring in the next quarter.
    • HierNumberOfSubsExpQtr; number; The count of subscription products, and its hierarchy, that are expiring in the current quarter.
    • 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.
    • HierPotentialRevenueOpenLeads; number; Total Potential Revenue from Qualified Open Leads of an account and its hierarchy
    • 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.
    • HierTotalNotes; number; The total number of notes for an account in 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.
    • NumberOfDecisionMakerContacts; number; Decision Maker Contacts
    • 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.
    • NumberOfQualifiedHotLeads; number; Qualified Hot Leads
    • NumberOfQualifiedLeads; number; Qualified Leads
    • NumberOfSrClosedPastWeek; number; Service Requests Closed in past Week
    • NumberOfSubsExpNxtQtr; number; Total Subscription Products Expiring in Next Quarter
    • NumberOfSubsExpQtr; number; Total Subscription Products Expiring in Current Quarter
    • 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.
    • PotentialRevenueOpenLeads; number; Total Potential Revenue from Qualified Leads
    • 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.
    • TotalNotes; number; The total number of notes for an account.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : accounts-AccountRollup
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : accounts-AccountRollup-item-response
Type: object
Show Source
Back to Top