Additional and Updated REST APIs

This new REST API inbound web service enables the orchestration (creation, updating, cancellation) of a field activity at a service point.

  • Field Activity (D1-FieldActivity)

NOTE: This only applies to Oracle Utilities Customer Cloud Service.

These updated REST API Inbound Web Services expose various customer- and metering-related entities and provide the capability to retrieve associated data:

  • Financial data for Accounts (C1-AccountData): Includes the current balance and total balance for each account through the enhanced Multi-Account Billing Statistics operation.
  • Bill (C1-Bill):
    • Create, manage, and view bill routing records for a bill through the Create Bill Routings, Update Bill Routings, and Get Bill Routings operations.
    • Option to include the Online Bill URL link to the image of a bill through the enhanced Get Bill operation.
  • Account (C1-Account):
    • Create, manage, and view an account's autopay record through the Create Account Autopay, Update Account Autopay, and Get Account Autopay operations.
    • Retrieve an account's alerts through the Get Account Alerts operation.
    • Retrieve an account's credit rating history though the Get Account Credit History Rating operation.
  • Budget (C1-Budget): Retrieve additional information for each eligible service agreement through the enhanced Get Budget operation (for example, CIS Division, CIS Division Description, Service Agreement Type, Service Agreement Type Description, and Service Type).
  • Usage data from Bills (C1-BilledUsageData):
    • Retrieve usage related highlights through the enhanced Billed Usage for SA operation (for example, average bill period usage, average daily usage, bill segment based on lowest usage, and bill segment based on highest usage).
  • Service Points Common (C1-ServicePointCommon): Retrieve billed reading information for service points of a premise through the Get Service Point Reading Details operation.
  • Business Person Queries (C1-PersonQueries): List top 10 persons with the highest overdue amount from a list of person IDs through the Top Overdue Accounts operation.
  • Outage Event Snapshot (C1-OutageEventNotifications): Receive an input list of outage event notifications to store the latest information about customers impacted by outages. Outage information can be integrated from an external system such as Oracle Utilities Network Management System. This integration leverages outage event information shared for notification purposes and will be used to enable insights and portals in future releases.

You can use these REST inbound web services to decrease project costs and timelines.

Steps to Enable

Refer to the Oracle Utilities API documentation.

Tips And Considerations

Implementations must purchase the appropriate subscriptions or license options to use the Inbound Web Services.

Key Resources

  • Refer to the Oracle Utilities API documentation.