Additional and Updated REST APIs

These new REST API inbound web services expose various customer-related entities and provide the capability to create/update/retrieve associated data:

  • Payment Template (C1-PaymentTemplate): Retrieves payment template details that are used to set up default payment allocations for non-CIS payments using distribution codes.
  • Outage Event (C1-OutageEvent): Retrieves list of outage events impacting a specific customer (account or person), or persons, and can optionally include outage events that are open, recently completed, or scheduled for the future.
  • AutoPay Source (C1-AutoPaySource): Retrieves auto pay sources for at least one criteria of an auto pay source code or description.

These updated REST API inbound web services expose various customer-related entities and provide the capability to create/update/retrieve associated data: 

  • Account (C1-Account)
    • New Operations
      • Replace Account Person
      • Update Account AutoPay (supports full record replace instead of update)
      • Get Account Effective AutoPay (returns the currently effective AutoPay information if an autoPayId is not provided in the URL)
      • Delete Account Autopay
    • Added "currency" element to AutoPay operations
    • The following operations include the "Allow Preferences" attribute to indicate whether a person's contacts can be used for the account's communication preferences:
      • Get Account
      • Update Account
      • Create Account Person
      • Get Account Person
      • Update Account Person
      • Replace Account Person
    • For the Main person linked to the account, the preferences will always be switched on and no modification is allowed. For other persons linked to the account, it is possible to allow preferences or not.
  • Maintain Communication Preferences (C1-CommunicationPreferences): Enhanced to include "Allow Preferences" attribute and allow this to be retrieved or enabled/disabled, where permitted, through the enhanced Get Communication Preferences and Patch Communication Preferences operations. Additionally, the Get Push Communication Details operation retrieves handling of a parent push notification type for an account.
  • Bill (C1-Bill)
    • Bill Summary now includes the Online Bill URL (bill image link).
    • Update Bill Routings is now a PATCH method.
    • Delete Bill Routings is now supported.
    • Get Bill response enhanced with "resultMessage" element.
  • Billing Context (C1-BillingContext): Options to return all accounts linked to a person through a related person (example, business) along with all accounts linked to the individual person in context through the enhanced Search Person Accounts operation.
  • Budget (C1-Budget): Retrieves the available budget plans for a billing account through the Search Budget Plans operation.
  • Outage Events Notifications (C1-OutageEventNotifications): Enhanced to enable efficient querying of outage events by other processes. Initiates synchronizing customer information to the Outage Entity table, after updating the Outage Event table with information received from an external outage management system.
  • Payment Event (C1-PaymentEvent): Supports retrieval of non-CIS payment event details and creation of non-CIS payment events (with manual distribution) through the enhanced Get Payment Event and Create Payment Event.\
  • Case (C1-Case): Removed the Delete Case operation as not a valid action from the user interface.
  • Customer Contact (C1-CustomerContact): Removed the Delete Customer Contact operation as not a valid action from the user interface.
  • Landlord Agreements (C1-LandlordAgreement): Removed the Delete Landlord Agreement operation as not a valid action from the user interface.

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.
  • For the Outage Events Notifications (C1-OutageEventNotifications) inbound web service, it is recommended the Outage Event Monitor (Deferred) (F1OTGEVT) batch control be scheduled to run regularly to update the Outage Entity table with the latest customer outage information. This is required when internal data synchronization may be deferred to background processing, to improve performance, when a large number of customers are impacted.

Key Resources

  • Refer to the Oracle Utilities API documentation.