Additional and Updated REST APIs

These new REST API Inbound Web Services expose various customer-related entities and data, and provide the capability to create, manage, and view that data:

  • Premise Activity History (C1-PremiseActivityHistory): Retrieves historical premise activity records and navigation details for activity types including cases, field activities, service orders, customer contacts, and severance or cut processes.
  • Person Financial Data (C1-PersonData): Retrieves debt details for a single customer, including list of billing accounts in collections and collections details.

These updated REST API Inbound Web Services also expose various customer-related entities and data, and allow you to manage that data:

  • Financial Data for Accounts (C1-AccountData): Retrieves high-level information about an account's active collections situation through the new Get Account Collection Details operation.
  • Billing Context (C1-Billing Context):
    • Retrieves account information of current and past customers who paid for services at a premise through the new Premise Customer History operation.
    • Provides a person or business indicator for each returned person in the Get Person Accounts operation.
  • Bill Segment (C1-Bill Segment): Includes the CIS Division Description in the responses.
  • Customer Activity History (C1-CustomerActivityHistory): Retrieves historical customer activity records and navigation details for activity types including customer contacts, bills, payments, field activities, service orders, service tasks through an optional offset input.
  • Premise (C1-Premise): Retrieves the average billing amounts for services linked to a premise through a new Premise Statistics Service operation.
  • Service Points Common (C1-ServicePointCommon): Retrieves usage history for a service point through the following operations:
    • Get Service Point Usage: Retrieves usage data for a given period and time scale.
    • Get Service Point Details:
      • Retrieves applicable unit of measures to graph usage data based on current date.
      • Retrieves granularity of available usage data.
  • Service Agreement (C1-ServiceAgreement): Searches by account or premise through a new SA Search operation.
  • Service Point Search (C1-ServicePointSearch): Retrieves additional service point information like installation date or device information for a given account, person or premise through an updated Search Service Point operation.

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.