Oracle Utilities REST API for Metering and Customer Information

All REST Endpoints

Admin/Dropdown Lists

This service retrieves the code and description values for a list of dropdowns.

Retrieve Dropdown Lists: Method: post
Path: /rest/apis/common/admin/dropdownLists/

Admin/Extendable Lookup Values

This service includes operations related to the extendable lookup values for a given extendable lookup business object.

Get Extendable Lookup Values: Method: get
Path: /rest/apis/common/admin/extendableLookupValues/{lookupBO}

Admin/Rates

A rate controls how service agreement charges are calculated, how charges are described on customer bills, and how the general ledger is affected by the charges.

Search Rate Schedules: Method: post
Path: /rest/apis/customer/admin/rates/search

Batch Services/Batch Job Submission

Batch Job Submission is used to submit application batch jobs for processing. This is the API to be used by external schedulers that do not want to use the internal scheduler.

Cancel Batch Job: Method: patch
Path: /rest/apis/common/batch/batchJobSubmission/{batchJobId}/cancel
Get Batch Job / Batch Run Details: Method: get
Path: /rest/apis/common/batch/batchJobSubmission/{batchJobId}
Submit Batch Job: Method: post
Path: /rest/apis/common/batch/batchJobSubmission/

Credit & Collections/Collection Process

A collection process is a series of events (e.g., letters, To Do entries) meant to encourage an account to pay its delinquent debt. Linked to the collection process are the specific service agreements that contributed to the delinquent debt.

Get Collection Process: Method: get
Path: /rest/apis/customer/collections/collectionProcesses/{collectionProcessId}

Credit & Collections/Cut Process

A cut process is a series of events (e.g., letters, To Do entries, field activities) that lead to the disconnection of service if outstanding debt is not paid.

Get Cut Process: Method: get
Path: /rest/apis/customer/collections/cutProcesses/{cutProcessId}

Credit & Collections/Overdue Process

An overdue process is a series of events (e.g., letters, To Do entries) meant to encourage an account to pay its delinquent debt. The system creates an overdue process when an account violates your overdue rules. In addition, a user can manually create an overdue process at their discretion.

Get Overdue Process: Method: get
Path: /rest/apis/customer/collections/overdueProcesses/{overdueProcessId}

Credit & Collections/Severance Process

A severance process is a series of events (e.g., letters, To Do entries, field activities) that lead to the severance of a service agreement if the outstanding debt is not paid. A separate severance process is required for each service agreement to be severed.

Get Severance Process: Method: get
Path: /rest/apis/customer/collections/severanceProcesses/{severanceProcessId}

Credit & Collections/Write Off Process

A write-off process is a series of events (e.g., letters, collection agency referrals) meant to encourage an account to pay its delinquent debt. Linked to the write-off process are the specific service agreements that contributed to the delinquent debt.

Get Write Off Process: Method: get
Path: /rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}

Data Synchronization/Master Data Synchronization

A sync request is used to send information to another system related to master data. Operations are used to respond to the sync request with either error information or with information to update for audit purposes.

Update Sync Request: Method: patch
Path: /rest/apis/common/sync/syncRequest/{syncRequestId}

Data Synchronization/Update Service Call Communication

This inbound service is used to process a service call communication acknowledgement message. The message contains communication ID, service call ID, service call number and error information. This service stores these information into the service call communication. If the message indicates an error, the service call communication is transitioned to the Error state. Otherwise, the service call communication is transitioned to the Synchronized state. For more information about service call communication, launch the online help and search for "Asset Management System Integration"

Update Service Call Communication: Method: patch
Path: /rest/apis/customer/sync/serviceCallCommunication/{serviceCallCommId}

Devices/Device Configurations

Device configurations manage details of a device such as measuring components of a physical meter.

create Device Configuration: Method: post
Path: /rest/apis/meter/devices/deviceConfigurations/
Delete Device Configuration: Method: delete
Path: /rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}
Get Device Configuration: Method: get
Path: /rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}
Update Device Configuration: Method: put
Path: /rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}

Devices/Item

Items can be either "badged" or "unbadged" . Badged items are devices that are individually tracked and can be installed at service point locations that typically have consumption but are not directly measured and therefore do not have any measuring components.

Create Item: Method: post
Path: /rest/apis/meter/devices/items/
Delete Item: Method: delete
Path: /rest/apis/meter/devices/items/{itemId}
Get Item: Method: get
Path: /rest/apis/meter/devices/items/{itemId}
Update Item: Method: put
Path: /rest/apis/meter/devices/items/{itemId}

Devices/Measuring Component

Measuring components are points for which data will be received and stored in the system. A measuring component can be associated to a device, which can have one or more measuring components, or it can be "virtual" or "stand-alone" meaning that it is not associated to a device.

Create Measuring Component: Method: post
Path: /rest/apis/meter/devices/measuringComponents/
Delete Measuring Component: Method: delete
Path: /rest/apis/meter/devices/measuringComponents/{measuringComponentId}
Get Measuring Component: Method: get
Path: /rest/apis/meter/devices/measuringComponents/{measuringComponentId}
Update Measuring Component: Method: put
Path: /rest/apis/meter/devices/measuringComponents/{measuringComponentId}

Devices/Meter

Meters are devices that measure utility consumption and can be installed at service point locations. There are different classes of meters with different attributes and behavior Smart Meter: these meters are associated to a head end system and support smart meter commands. The measuring components associated to these devices are expected to be read very frequently. These meters support periodic estimation AMR Meter: these meters may also be associated to a head end system but they do not support smart meter commands. The measuring components are read frequently. Manual Meter: these meters are seldom read and do not support smart meter commands.

Create Meter: Method: post
Path: /rest/apis/meter/devices/meters/
Delete Meter: Method: delete
Path: /rest/apis/meter/devices/meters/{meterId}
Get Meter Details: Method: get
Path: /rest/apis/meter/devices/meters/{meterId}
Update Meter: Method: put
Path: /rest/apis/meter/devices/meters/{meterId}

Financial Transactions/AP Check Request

This service allows an external system to update the check-related information on an existing AP Check Request record after the check has been cut. If the AP Check Request is being canceled, this service also cancels the related adjustment.

AP Check Request Maintenance: Method: put
Path: /rest/apis/customer/financials/apCheckRequest/{apRequestId}

Financial Transactions/Adjustment

An adjustment is a type of financial transaction that effects a service agreement's debt and financial impact on the general ledger.

Action Adjustment: Method: patch
Path: /rest/apis/customer/financials/adjustments/{adjustmentId}/lifecycle
Adjustment Summary: Method: get
Path: /rest/apis/customer/financials/adjustments/{adjustmentId}/summary
Create Adjustment: Method: post
Path: /rest/apis/customer/financials/adjustments/
Delete Adjustment: Method: delete
Path: /rest/apis/customer/financials/adjustments/{adjustmentId}
Get Adjustment: Method: get
Path: /rest/apis/customer/financials/adjustments/{adjustmentId}

Financial Transactions/Bill

A bill is produced for an account and many bills are produced for an account over time. Bills charge for the services or products supplied to a customer.

Action Bill: Method: patch
Path: /rest/apis/customer/financials/bills/{billId}/lifecycle
Bill Summary: Method: get
Path: /rest/apis/customer/financials/bills/{billId}/summary
Create Bill: Method: post
Path: /rest/apis/customer/financials/bills/
Delete Bill: Method: delete
Path: /rest/apis/customer/financials/bills/{billId}
Get Bill: Method: get
Path: /rest/apis/customer/financials/bills/{billId}
Search Bills: Method: post
Path: /rest/apis/customer/financials/bills/search

Financial Transactions/Bill Segment

A bill typically contains one bill segment for every active service agreement linked to its account. A bill segment contains information showing how the segment was calculated and how it should be printed on the customer's bill.

Action Bill Segment: Method: patch
Path: /rest/apis/customer/financials/billSegments/{billSegmentId}/lifecycle
Bill Segment Search: Method: post
Path: /rest/apis/customer/financials/billSegments/search
Bill Segment Summary: Method: get
Path: /rest/apis/customer/financials/billSegments/{billSegmentId}/summary
Create Bill Segment: Method: post
Path: /rest/apis/customer/financials/billSegments/
Delete Bill Segment: Method: delete
Path: /rest/apis/customer/financials/billSegments/{billSegmentId}
Get Bill Segment: Method: get
Path: /rest/apis/customer/financials/billSegments/{billSegmentId}

Financial Transactions/Budget

The Budget contains information about all service agreements linked to an account that are eligible to participate in a budget billing plan.

Action Budget: Method: patch
Path: /rest/apis/customer/financials/budgets/{accountId}/lifecycle
Get Budget: Method: get
Path: /rest/apis/customer/financials/budgets/{accountId}

Financial Transactions/Financial data for Accounts

The operations in this web service provide financial history, current financial details, and financial statistics for a historical period.

Account Financial Statistics: Method: post
Path: /rest/apis/customer/financials/accountData/{accountId}/financialStatistics
Get Account Collection Details: Method: get
Path: /rest/apis/customer/financials/accountData/{accountId}/collectionDetails
Get Account Financial Details: Method: get
Path: /rest/apis/customer/financials/accountData/{accountId}/financialDetails
Get Account Financial History: Method: get
Path: /rest/apis/customer/financials/accountData/{accountId}/financialHistory
Multi-Account Billing Statistics: Method: post
Path: /rest/apis/customer/financials/accountData/multiAccountStatistics

Financial Transactions/Pay Plan

A pay plan (PP) is an agreement with a customer to make payments on specific dates. Pay plans differ from payment arrangements in that pay plans have user-defined scheduled payment dates, which are independent from the customer's billing dates. In other words, payment arrangements appear on the customer's bills, pay plan scheduled payments do not.

Create Pay Plan: Method: post
Path: /rest/apis/customer/financials/payPlans/
Get Pay Plan: Method: get
Path: /rest/apis/customer/financials/payPlans/{payPlanId}

Financial Transactions/Payment

Payments record the financial impact to offset arrears of an account. A payment can have multiple payment segments for the financial impact to offset arrears of each service agreement.

Action Payment: Method: patch
Path: /rest/apis/customer/financials/payments/{paymentId}/lifecycle
Create Payment: Method: post
Path: /rest/apis/customer/financials/payments/
Delete Payment: Method: delete
Path: /rest/apis/customer/financials/payments/{paymentId}
Get Pay Segments: Method: get
Path: /rest/apis/customer/financials/payments/{paymentId}/paySegments
Get Payment: Method: get
Path: /rest/apis/customer/financials/payments/{paymentId}
Get Payment Summary: Method: get
Path: /rest/apis/customer/financials/payments/{paymentId}/summary

Financial Transactions/Payment Event

A payment event records an overall transaction whenever any form of payment is received. The payment event can span payments across multiple accounts and can include multiple payment tenders.

Action Payment Event: Method: patch
Path: /rest/apis/customer/financials/paymentEvents/{paymentEventId}/lifecycle
Create Payment Event: Method: post
Path: /rest/apis/customer/financials/paymentEvents/
Delete Payment Event: Method: delete
Path: /rest/apis/customer/financials/paymentEvents/{paymentEventId}
Get Payment Event: Method: get
Path: /rest/apis/customer/financials/paymentEvents/{paymentEventId}
Search Payment Event Payments: Method: post
Path: /rest/apis/customer/financials/paymentEvents/payments/search

Financial Transactions/PaymentTender

Payment tenders exist for every form of tender, such as paying with cash, a check, or a credit card, remitted as part of a payment event. A payment event must have at least one tender otherwise nothing is remitted. A payment event may have many tenders when multiple payment methods are associated with an event.

Action Payment Tender: Method: patch
Path: /rest/apis/customer/financials/paymentTenders/{paymentTenderId}/lifecycle
Create Payment Tender: Method: post
Path: /rest/apis/customer/financials/paymentTenders/
Get Payment Tender: Method: get
Path: /rest/apis/customer/financials/paymentTenders/{paymentTenderId}

Financial Transactions/SA data

The operations in this web service provide list of UOMs applicable to SA, and financial statistics

SA UOMs and Financial Statistics: Method: get
Path: /rest/apis/customer/financials/saData/billingDetails/{serviceAgreementId}

Interactions/Case

Cases are a highly configurable object that can be used to handle various types of requests that can be tracked and require a workflow to enable resolution.

Action Case: Method: patch
Path: /rest/apis/customer/interactions/cases/{caseId}/action
Create Case: Method: post
Path: /rest/apis/customer/interactions/cases/
Delete Case: Method: delete
Path: /rest/apis/customer/interactions/cases/{caseId}
Get Case: Method: get
Path: /rest/apis/customer/interactions/cases/{caseId}
Search Case: Method: post
Path: /rest/apis/customer/interactions/cases/search
Update Case: Method: put
Path: /rest/apis/customer/interactions/cases/{caseId}

Interactions/Customer Activity History

Historical customer activity records and navigation details for activity types including customer contacts, bills, payments, field activities, service orders, service tasks.

Get Customer Activity History: Method: get
Path: /rest/apis/customer/interactions/customerActivityHistory/{accountId}

Interactions/Customer Contact

Customer contacts are used to record when and why a customer contacted your company or to initiate an outbound communication such as a letter that can be extracted for print and delivery.

Create Customer Contact: Method: post
Path: /rest/apis/customer/interactions/customerContacts/
Delete Customer Contact: Method: delete
Path: /rest/apis/customer/interactions/customerContacts/{customerContactId}
Get Customer Contact: Method: get
Path: /rest/apis/customer/interactions/customerContacts/{customerContactId}
Update Customer Contact: Method: put
Path: /rest/apis/customer/interactions/customerContacts/{customerContactId}

Service/Appointment Tasks

Appointment tasks are used to request and track appointments related to service order field activities for the customer via self-service portals.

Book Appointment: Method: post
Path: /rest/apis/cross/service/appointmentTasks/
Cancel Appointment: Method: patch
Path: /rest/apis/cross/service/appointmentTasks/{referenceId}/cancel
Retrieve Pending Tasks: Method: post
Path: /rest/apis/cross/service/appointmentTasks/tasks
Search Appointment Slots: Method: post
Path: /rest/apis/cross/service/appointmentTasks/availableSlots
Search For Tasks: Method: post
Path: /rest/apis/cross/service/appointmentTasks/reasons

Service/Start Stop Transfer Tasks

Start Stop Transfer Tasks

Clear Other Person: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/otherPersonReset
Deposit Assessment: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/depositAssessment
Determine Services To Start: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/servicesToStart
Determine Services To Stop: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/servicesToStop
Process Other Person: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/otherPersonProcessing
Process Services To Start: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/serviceToStartProcessing
Process Services To Stop: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/serviceToStopProcessing
Retrieve Request Type Details: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/requestTypeDetails
Retrieve Service-Related Customer Details: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/serviceRelatedCustomerDetails
Retrieve Services To Stop: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/stoppableServiceDetails
Service Eligibility: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/serviceEligibility
Service Questions: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/serviceQuestions
Start Service Finalization: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/startServiceFinalization
Stop Service Finalization: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/stopServiceFinalization
Transfer Service Finalization: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/transferServiceFinalization
Validate Start SP Selection: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/startSPSelectionValidation
Validate Stop Service Agreement Selection: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/stopSASelectionValidation

Service/Web User

Web users can be associated with customer persons to keep logins from an integrated self-service application, such as Oracle Utilities Digital Self-Service.

Create Web User: Method: post
Path: /rest/apis/customer/service/webUsers/
Delete Web User: Method: delete
Path: /rest/apis/customer/service/webUsers/{webUserId}
Get Web User: Method: get
Path: /rest/apis/customer/service/webUsers/{webUserId}
Update Web User: Method: put
Path: /rest/apis/customer/service/webUsers/{webUserId}

Service/Web User Account

Web users can be associated with customer accounts that are linked to a login from an integrated self-service application, such as Oracle Utilities Digital Self-Service.

Create Web User Account: Method: post
Path: /rest/apis/customer/service/webUserAccounts/
Delete Web User Account: Method: delete
Path: /rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}
Get Account Verification Details: Method: get
Path: /rest/apis/customer/service/webUserAccounts/{accountId}/accountVerificationInfo
Get Web User Account: Method: get
Path: /rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}
Search Web User Accounts: Method: get
Path: /rest/apis/customer/service/webUserAccounts/{webUserId}
Update Web User Account: Method: put
Path: /rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}

Service/Work Queue

Work queue of To Do Entries assigned to the user.

Get Work Queue: Method: get
Path: /rest/apis/customer/service/workQueue/

System Services/Expand Tree

This service handles tree node expansion functionality.

Expand Tree Node: Method: post
Path: /rest/apis/common/system/treeNodes/expandNode

System Services/Insights

This service includes operations related to retrieval of context based insights.

Retrieve Insights: Method: post
Path: /rest/apis/common/system/insights/

System Services/Installation Options

This service includes operations related to the Framework installation options. Its primary purpose is to provide the ability to view and update customer release details.

Get Customer Release: Method: get
Path: rest/apis/common/system/installationOptions/customerRelease/customerRelease
Update Customer Release: Method: patch
Path: rest/apis/common/system/installationOptions/customerRelease/customerRelease

To Do Entries/To Do Entry

A To Do Entry is either created manually by a user or generated by the system as a result of an event or issue that needs attention. The To Do Entry represents a task to be performed or an issue to be investigated.

Assign Next To Do Entry: Method: post
Path: /rest/apis/common/toDos/toDoEntries/assignNextToDoEntry
Get To Do Entry: Method: get
Path: /rest/apis/common/toDos/toDoEntries/{toDoEntryId}
Get To Do Entry Logs: Method: get
Path: /rest/apis/common/toDos/toDoEntries/{toDoEntryId}/logs

Usage/Usage Transaction

Usage Transactions are records of a given usage calculation for a period of time for a Usage Subscription. All of the Service Quantities (often referred to as bill determinants) calculated are stored in the Usage Transaction. When calculating a Usage Transaction, the first step in calculating the usage is for the system to determine the usage calculation group holding the rules set used in calculating or validating the quantities. Usage transaction requests must specify the date range for the usage transaction. This date range is referred to as the calculation period for the usage transaction. In situations where a meter exchange has taken place at a service point, more than one device configuration can be in effect during the usage transactions cutoff period (the time period between the End Date/Time From and End Date/Time To values). Date breaks are used to break up a usage period into sub-periods based on the dates on which rate changes took place for the service point. One approach to this situation would be for the subscribing system to request two usage transactions (where each has the desired date range). Another approach is for the subscribing system to request a single usage transaction with date breaks that define the date ranges before and after the rate change. If a usage transaction has date break(s), the usage calculation engine segregates the usage into multiple usage periods based on the date breaks. If there are no date breaks in the usage transaction, a single usage period is created for the entire calculation period. Every usage period created for a usage transaction contains one or more service quantities. Service quantities are calculated by the usage calculation group's rules specified for the usage subscription from which the usage transaction is created. Each service quantity lists details about that quantity, including a UOM (or TOU or SQI as appropriate) and a quantity. In addition, each service quantity also references the source (measuring component) of the quantities (for audit purposes). Usage transaction service quantities can also contain information about the quality of the measurements used in their calculations and other information that can be sent to an external system. Some usage calculation rules can be configured to identify the date/time of the maximum or minimum measurement value used when calculating the service quantity. For these functions, if "Max" or "Min" is selected as the "Calculation Function" (or the "Comax" and "Comin" functions), the date/time of the maximum/minimum value will be included in the resulting usage transaction. The "SQ Highlight Date/Time List" contains a list of maximum/minimum date/times, based on condition/quality. Usage transactions can also calculate usage for items installed at service points. The specifics of how usage is calculated for items is based on the service point category (defined on the service point type) at which the items are installed (item or multi-item). The system can also perform rate comparison calculations to see impacts to usage and billing charges based on a set of user-defined usage adjustments. Rate comparison usage transactions are flagged "Hypothetical Calculation" in the Calculation Mode field. Usage transactions can be configured to include summary service quantities and an interval data "snapshot" along with service quantities and other information sent to external systems. This used when sending usage to a billing system that performs interval-based pricing calculations.

Action Usage Transaction Service: Method: patch
Path: /rest/apis/meter/usage/usageTransactions/{usageTransactionId}/lifecycle
Create Usage Transaction: Method: post
Path: /rest/apis/meter/usage/usageTransactions/
Delete Usage Transaction: Method: delete
Path: /rest/apis/meter/usage/usageTransactions/{usageTransactionId}
Get Usage Transaction: Method: get
Path: /rest/apis/meter/usage/usageTransactions/{usageTransactionId}
Update Usage Transaction: Method: put
Path: /rest/apis/meter/usage/usageTransactions/{usageTransactionId}

Usage/Usage data from Bills

Service to get usage values from bill segment SQ collections - for Accounts and Service Agreements over time periods

Billed Usage for SA: Method: post
Path: /rest/apis/customer/usage/usageData/serviceAgreementBilledUsage
Multi-Account Usage Summary for a date range: Method: post
Path: /rest/apis/customer/usage/usageData/multiAccountSummary
Single Service Usage Summary for a date range: Method: post
Path: /rest/apis/customer/usage/usageData/singleServiceSummary

V-Model/Account

Accounts manage the financial relationship with an end customer for which bills are created based on service agreements. The account contains information that controls when the bills are generated and how they are formatted for related persons.

Create Account: Method: post
Path: /rest/apis/customer/v-model/accounts/
Create Account Person: Method: post
Path: /rest/apis/customer/v-model/accounts/{accountId}/persons
Delete Account: Method: delete
Path: /rest/apis/customer/v-model/accounts/{accountId}
Delete Account Person: Method: delete
Path: /rest/apis/customer/v-model/accounts/{accountId}/persons
Get Account: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}
Get Account Person: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}/persons/{personId}
Update Account: Method: put
Path: /rest/apis/customer/v-model/accounts/{accountId}
Update Account Person: Method: put
Path: /rest/apis/customer/v-model/accounts/{accountId}/persons

V-Model/Billing Context

Represents a billing context for various types of queries.

Customer History for a Premise: Method: get
Path: /rest/apis/customer/v-model/billingContext/premiseCustomerHistory/{premiseId}
Get Billing Account Context: Method: get
Path: /rest/apis/customer/v-model/billingContext/accountContext/{accountId}
Get Person Accounts: Method: get
Path: /rest/apis/customer/v-model/billingContext/personContext/{personId}
Search Account Premises: Method: post
Path: /rest/apis/customer/v-model/billingContext/premises
Search Person Accounts: Method: post
Path: /rest/apis/customer/v-model/billingContext/searchPersonAccounts

V-Model/Business Person Queries

Get Business Summary retrieves summary details for the provided person id. This summary is intended for persons of type business that may have multiple active billing accounts and premise service locations.

Business Person Summary: Method: post
Path: /rest/apis/customer/v-model/businessPersonQueries/

V-Model/Business Search

This service is used by the CX4U Key Account Management (KAM) Customer List page to find business person records based on specific filters.

Business Search: Method: post
Path: /rest/apis/customer/v-model/businessSearch/

V-Model/Communications Preferences

Centralized maintenance of a person's communication preferences by notification types allowed for an account.

Get Communications Preferences: Method: get
Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}
Get Mailing Addresses: Method: get
Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses
Patch Communications Preferences: Method: patch
Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}
Update Mailing Address: Method: patch
Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses

V-Model/Create/Update Customer Contact

This service is used to add or update customer contacts that represent a record of a digital notification. Notifications that originated in this application are updated and those that originated in external systems such as NMS are added and updated. The customer contact log is used to record the status of the notification, such as if it has been delivered, opened, or bounced. The current status is updated on the customer contact record in addition to other information relevant to the notification.

Create Update Customer Contact: Method: put
Path: /rest/apis/customer/v-model/customerContact/{externalCCId}

V-Model/Entity References

This service supports operations for a selected list of entities that are captured as external references on CX4U entities such as SR, lead, opportunity etc.

Entity References Summary: Method: post
Path: /rest/apis/customer/v-model/entityReferences/hierarchyInfo

V-Model/Install Events

Install Events manage the physical installation of devices such as meters or badged items at service point connection locations including relationships to markets and service providers and communication between devices or schedules for manual meter reading. Whenever a device is installed at a Service Point, an installation event is created. Installation events capture the history of the devices that have been installed at a Service Point. This allows consumption for a Service Point to be calculated over time. In technical terms, installation events (or Install Events) link a specific Device Configuration to a Service Point. There are specific Install Event business objects for different types of devices, including smart meters, items, manual meters, and communication components. When creating Install Events for items, only "badged" items (those that are uniquely identified in some way) use item Install Events. "Unbadged" items do not use Install Events. Instead, the number of each type of item is specified in the "Multi-Item Detail" section of the Service Point. While a device is installed at a Service Point, it may be turned off (and back on again). The installation event that records the original installation date and time also records the dates and times when the device has been turned on and off. When a device is removed, the original installation event is updated with the removal date and time.

Create Install Event: Method: post
Path: /rest/apis/meter/v-model/installEvents/
Delete Install Event Details: Method: delete
Path: /rest/apis/meter/v-model/installEvents/{installEventId}
Get Install Event: Method: get
Path: /rest/apis/meter/v-model/installEvents/{installEventId}
Update Install Event Details: Method: put
Path: /rest/apis/meter/v-model/installEvents/{installEventId}

V-Model/Landlord Agreements

A landlord agreement maintains a landlord's service reversion preferences. A landlord will have at least one landlord agreement. However, if the landlord has different service reversion preferences for different properties, you can create multiple landlord agreements - one for each set of preferences. After a landlord's reversion preferences have been defined, the landlord agreement record can be linked to the respective premises.

Create Landlord Agreement: Method: post
Path: /rest/apis/customer/v-model/landlordAgreements/
Delete Landlord Agreement: Method: delete
Path: /rest/apis/customer/v-model/landlordAgreements/{landLordId}
Get Landlord Agreement: Method: get
Path: /rest/apis/customer/v-model/landlordAgreements/{landLordId}
Update Landlord Agreement: Method: put
Path: /rest/apis/customer/v-model/landlordAgreements/{landLordId}

V-Model/Notification Preferences for Accounts

This REST web service retrieves notification preferences for a collection of accounts and notification types. This can be used to enable notification types that are triggered by other applications such as Oracle Utilities Network Management System that need to be sent directly to an outbound notification system such as Oracle Responsys instead of initiating the notifications through this application with a Create Notifications service.

Retrieve Notification Preferences for Accounts: Method: post
Path: /rest/apis/customer/v-model/notificationPreferencesForAccounts/

V-Model/Person

Person records can exist for individuals or businesses with which your company has contact related to a service provided . Besides customers, persons can exist for landlords, contractors, third party guarantors, energy distributors or other service providers, collection agencies, etc.

Create Person: Method: post
Path: /rest/apis/customer/v-model/persons/
Delete Person: Method: delete
Path: /rest/apis/customer/v-model/persons/{personId}
Get Person: Method: get
Path: /rest/apis/customer/v-model/persons/{personId}
Person Search: Method: post
Path: /rest/apis/customer/v-model/persons/search
Update Person: Method: put
Path: /rest/apis/customer/v-model/persons/{personId}

V-Model/Person Information Synchronization

Synchronization of person records for an individual or business with which your company has interactions and could be synchronized with CX applications. Synchronized person information includes primary name and contact information such as phone number or email address.

Sync Person: Method: put
Path: /rest/apis/customer/v-model/cxPersons/{cxContactId}

V-Model/Person Search

This service is used by the CX4U Customer List agent page to find person or business records based on specific filters. The response includes the list of active accounts and premises associated with each matching record.

Person Search: Method: post
Path: /rest/apis/customer/v-model/personSearch/

V-Model/Premise

The premise record contains geographic information about your service addresses. A premise can have service points at which meters can be installed to measure utility services supplied to the premise.

Create Premise: Method: post
Path: /rest/apis/customer/v-model/premises/
Delete Premise: Method: delete
Path: /rest/apis/customer/v-model/premises/{premiseId}
Get Premise: Method: get
Path: /rest/apis/customer/v-model/premises/{premiseId}
Premise Statistics: Method: post
Path: /rest/apis/customer/v-model/premises/premiseStatistics
Search Premises: Method: post
Path: /rest/apis/customer/v-model/premises/search
Update Premise: Method: put
Path: /rest/apis/customer/v-model/premises/{premiseId}

V-Model/Service Agreement

A service agreement is as a contract between your company and a customer. The service agreement contains the terms and conditions controlling how the system calculates charges for the specific service or product supplied to the customer.

Create Service Agreement: Method: post
Path: /rest/apis/customer/v-model/serviceAgreements/
Delete Service Agreement: Method: delete
Path: /rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}
Get Service Agreement: Method: get
Path: /rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}
SA Search: Method: post
Path: /rest/apis/customer/v-model/serviceAgreements/search
Update Service Agreement: Method: put
Path: /rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}

V-Model/Service Point Search

Service Point Search

Retrieve Service Points Info corresponding to a Premise: Method: get
Path: /rest/apis/customer/v-model/servicePointSearch/{premiseId}/getServicePointsInfoForPremise
Search Service Point: Method: post
Path: /rest/apis/customer/v-model/servicePointSearch/

V-Model/Service Points Common

This Inbound Web Service provides an operation for the display-oriented summary of a Service Point, which can be used across both CCB and C2M environments. When used in C2M the summary will also include additional fields that are stored on the MDM Service Point.

Get Service Point Summary: Method: get
Path: /rest/apis/customer/v-model/servicePointsCommon/{servicePointId}/summary
Retrieve SP Usage: Method: post
Path: /rest/apis/customer/v-model/servicePointsCommon/servicePointUsage
Retrieve UOMs and granularity details for SP: Method: post
Path: /rest/apis/customer/v-model/servicePointsCommon/servicePointDetails

V-Model/Service Points/Customer Care and Billing

Service points are a physical location (usually meter connection socket) at which a company supplies service. Devices are installed at service points, and the relationship between individual service points and devices can change over time.

Create Service Point: Method: post
Path: /rest/apis/customer/v-model/servicePoints/
Delete Service Point: Method: delete
Path: /rest/apis/customer/v-model/servicePoints/{servicePointId}
Get Service Point: Method: get
Path: /rest/apis/customer/v-model/servicePoints/{servicePointId}
Update Service Point: Method: put
Path: /rest/apis/customer/v-model/servicePoints/{servicePointId}

V-Model/Service Points/Customer to Meter

Service points are a physical location (usually meter connection socket) at which a company supplies service that can be used to store information describing the type of service supplied and how it is measured. Devices are installed at service points, and the relationship between individual service points and devices can change over time. For example, over time different devices may be installed at a service point, and a device may be installed at different service points. A service point may only have one device. If multiple devices at a service point are required, define a parent and child service point relationship to create a hierarchy of service points. On each service point, users will be able to specify a parent service point. An example of this feature would be to link each condominium in a building to a parent service point that represents the common areas of the building. Another example would be a deregulated service point that allows multiple devices per service point. In this example, the parent service point would be the market service point ID and the children service points would relate to the individual devices.

Create Service Point: Method: post
Path: rest/apis/cross/v-model/servicePoints/
Delete Service Point: Method: delete
Path: rest/apis/cross/v-model/servicePoints/{servicePointId}
Get Service Point: Method: get
Path: rest/apis/cross/v-model/servicePoints/{servicePointId}
Search SP for Premise: Method: post
Path: rest/apis/cross/v-model/servicePoints/search
Update Service Point: Method: put
Path: rest/apis/cross/v-model/servicePoints/{servicePointId}

V-Model/Service Points/Meter Data Management

Create Service Point: Method: post
Path: /rest/apis/meter/v-model/servicePoints/
Delete Service Point: Method: delete
Path: /rest/apis/meter/v-model/servicePoints/{servicePointId}
Get Service Point: Method: get
Path: /rest/apis/meter/v-model/servicePoints/{servicePointId}
Update Service Point: Method: put
Path: /rest/apis/meter/v-model/servicePoints/{servicePointId}

V-Model/Unsubscribe Notifications

This service is used to process request to unsubscribe or opt-out of receiving notifications. Notifications are sent based on active preferences, or the system can derive a default preference. Some notification types allow customers to opt-out from receiving future notifications while some do not. Sometimes a customer has signed up to receive the same notification to more than one destination such as two email address or an email and text (SMS). In these instances, the customer is only unsubscribed from the source of the message where this request originated. Lastly, the customer's preferences may have changed since the notification as send. For example, the user may unsubscribe from an old email. This service ensures the information in the request is current before processing the request. This service handles the above situations and returns an informational message based on the situation. The informational message catalog entries are provided here so you can customize the message text. Already unsubscribed. (11120, 11071) Unsubscribe successful. (11120, 11072) Unsubscribe successful. Other active preferences for the same notification type. (11120, 11073) Unsubscribe successful. Opt-out created. (11120, 11075) Unsubscribe not successful. Information in request does not match system. (11120, 11076) Unsubscribe not successful. Opt-out not created. Notification type belongs to a different parent than when it was sent. (11120, 11078) (11120, 11079) Unsubscribe successful. Opt-out not allowed.

Unsubscribe Notifications: Method: post
Path: /rest/apis/customer/v-model/C1UnsubscribeNotifications/

V-Model/Usage Subscription

A Usage Subscription is an ongoing request to send one or more Service Points' usage detail to one or more external systems. The Usage Subscription defines which usage calculation group should be used to calculate Service Quantities (often referred to as bill determinants). Usage subscriptions must reference a: Service Provider: The service provider is used as the identity of the subscribing system. In other words, you must set up a service provider for any system that subscribes to usage calculations. Contact: Contacts are individuals or business entities with which a company has contact. A contact exists for every individual or business related to a usage subscription. A single usage subscription can have many contacts, and a single contact may be referenced on many different usage subscriptions. Contacts have a 1-to-1 correlation with a "person" in a customer information system (CIS) and the CIS is considered the system of record for contact information.

Create Usage Subscription: Method: post
Path: /rest/apis/meter/v-model/usageSubscriptions/
Delete Usage Subscription: Method: delete
Path: /rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}
Get Usage Subscription: Method: get
Path: /rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}
Update Usage Subscription: Method: put
Path: /rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}