Oracle Utilities REST API for Metering and Customer Information

All REST Endpoints

Admin/AutoPay Source

Autopay sources must be configured with unique routing information for every bank, credit card company, and bill payment service that customers use as the source of the funds for automatic payments.

Search AutoPay Sources: Method: post
Path: /rest/apis/customer/admin/autoPaySources/search

Admin/Dropdown Lists

Data for available dropdown lists includes a list of valid codes and their corresponding descriptions.

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/Payment Template

Payment templates can be configured to default payment allocations for non-CIS payments using distribution codes.

Get Payment Template Details: Method: get
Path: /rest/apis/customer/admin/paymentTemplates/{paymentTemplate}

Admin/Rates

Rates control how service agreement charges are calculated, how charges are described on customer bills, and how the general ledger is affected by each line item of the charges.

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

Admin/Service Agreement Type

Service agreement types define what services are provided and sold, eligible rates, applicable service point types, how overdue debt is collected, and how revenue is booked in the general ledger.

Search Service Agreement Types: Method: post
Path: /rest/apis/customer/admin/saTypes/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

Collection processes are a series of events (for example, letters, to do workflow, and so on) meant to encourage an account to pay its delinquent debt. The specific service agreements that contributed to the delinquent debt are linked to the collection process.

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

Credit & Collections/Cut Process

Cut processes are a series of events (for example, letters, to do entries, and field activities) that can 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

Overdue processes are a series of events (for example, 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, or 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 (for example, letters, to do entries, and 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

Write-off processes are a series of events (for example, letters, collection agency referrals) meant to encourage an account to pay its delinquent debt. The specific service agreements that contributed to the delinquent debt are linked to the write-off process.

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

Data Synchronization/Master Data Synchronization

A sync request is used by this product to send information to another product related to shared master data. Operations for this API 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 service is used to process work and asset management-related service call information gathered from interactions with the customer, the public, or other external entity. These interactions can include reporting a new issue or request, adding comments to an existing issue or request, or requesting cancellation (issue is resolved or request no longer needed).

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. Unbadged items are counted by type and number installed, but are not individually tracked.

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 represent registers or channels for which data is received and stored in the system. A measuring component can be associated with a metering 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. Meters can be smart and associated with a head end system to support automated commands and interval measurement data collection, associated with an automated reading system without smart commands, or manually read and operated.

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/Accounts Payable Check Request

Adjustments for an adjustment type marked with an Accounts Payable check request code are interfaced to an external system to issue checks for disbursement of funds.

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

Financial Transactions/Adjustment

Adjustments are a type of financial transaction that affects a service agreement's debt and financial impact on the general ledger.

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}
Update Adjustment Lifecycle Action: Method: patch
Path: /rest/apis/customer/financials/adjustments/{adjustmentId}/lifecycle

Financial Transactions/Bill

Bills are produced for an account, with many bills produced for an account over time. Bills typically contain charges as bill segments for each of the services or products supplied to a customer.

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

Financial Transactions/Bill Segment

Bill segments typically exist for every active service agreement linked to an account during a bill period. A bill segment contains information showing how the charges were calculated and how each line of detail should be printed on the bill.

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}
Update Bill Segment Lifecycle Action: Method: patch
Path: /rest/apis/customer/financials/billSegments/{billSegmentId}/lifecycle

Financial Transactions/Budget

Budget plan enrollments for an account enable fixed recurring bill amounts for service agreements that are eligible to participate.

Get Budget: Method: get
Path: /rest/apis/customer/financials/budgets/{accountId}
Search Budget Plans: Method: get
Path: /rest/apis/customer/financials/budgets/{accountId}/searchBudgetPlans
Update Budget Lifecycle Action: Method: patch
Path: /rest/apis/customer/financials/budgets/{accountId}/lifecycle

Financial Transactions/Financial Data for Accounts

The operations in this web service provide data for an account such as 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

Pay plans are an agreement with a customer to make payments on specific dates. Pay plans differ from payment arrangements in that pay plans have scheduled payment dates, which are independent from the customer's billing dates.

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.

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
Update Payment Lifecycle Action: Method: patch
Path: /rest/apis/customer/financials/payments/{paymentId}/lifecycle

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.

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
Update Payment Event Lifecycle Action: Method: patch
Path: /rest/apis/customer/financials/paymentEvents/{paymentEventId}/lifecycle

Financial Transactions/Payment Tender

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.

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

Financial Transactions/Person Financial Data

The operations in this web service provide data for a person such as financial details for accounts in collections with overdue debt.

Get Person Accounts Collection Details: Method: get
Path: /rest/apis/customer/financials/personData/{personId}/collectionDebtList
Get Person Collection Details: Method: get
Path: /rest/apis/customer/financials/personData/{personId}/collectionDetails

Financial Transactions/Service Agreement Data

The operations in this web service provide data for a service agreement such as financial statistics and a list of units of measure that are applicable based on the rate and granularity of usage data that is available.

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

Interactions/Case

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

Create Case: Method: post
Path: /rest/apis/customer/interactions/cases/
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}
Update Case Lifecycle Action: Method: patch
Path: /rest/apis/customer/interactions/cases/{caseId}/action

Interactions/Customer Activity History

Historical customer activity records and navigation details for activity types including customer contacts, bills, payments, field activities, service orders, and 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 is contacted through an inbound communication channel or to initiate an outbound communication that can be sent for delivery.

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

Interactions/Premise Activity History

Historical activity records for a premise, based on associated service for customers during the time period, with navigation details for activity types including cases, field activities, service orders, customer contacts, and severance or cut processes.

Get Premise Activity History: Method: get
Path: /rest/apis/customer/interactions/premiseActivityHistory/{premiseId}

Service/Appointment Tasks

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

Cancel Appointment: Method: patch
Path: /rest/apis/cross/service/appointmentTasks/{referenceId}/cancel
Create Appointment: Method: post
Path: /rest/apis/cross/service/appointmentTasks/
Get Pending Field 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/Field Activity

Service order management field activities trigger a request for a utility to send workers into the field to perform actions at a location such as a service point. This can include device installation, replacement, and other activities. The requests can be integrated using an asynchronous message to an external field work system for scheduling and dispatch to a field crew to complete the activity.

Cancel Field Activity: Method: patch
Path: /rest/apis/meter/service/fieldActivities/{activityId}/cancel
Create Field Activity: Method: post
Path: /rest/apis/meter/service/fieldActivities/
Get Field Activity: Method: get
Path: /rest/apis/meter/service/fieldActivities/{activityId}
Update Field Activity: Method: put
Path: /rest/apis/meter/service/fieldActivities/{activityId}

Service/Outage Event

Outage events are integrated from an external outage system. The events can be searched for impacts to a specific customer (account or person) with filters for the outage status type to include open events, recently completed, or scheduled in near future outage events.

Outage Events Persons Summary: Method: post
Path: /rest/apis/customer/service/outageEvent/personsSummary
Search Outage Events: Method: post
Path: /rest/apis/customer/service/outageEvent/search

Service/Outage Event Notifications

This service receives a list of outage events 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.

Create or Update Outage Events: Method: post
Path: /rest/apis/customer/service/outageEventNotifications/

Service/Start Stop Transfer Tasks

Tasks are used by a self-service application to integrate transactions for new service, add service, stop service, and transfer service. An associated customer service request type defines the customer service request business objects used to save data, and the controls used throughout the transaction.

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
Finalize Stop Service: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/stopServiceFinalization
Finalize Transfer Service: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/transferServiceFinalization
Get Services To Stop: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/stoppableServiceDetails
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 Questions: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/serviceQuestions
Retrieve Service-Related Customer Details: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/serviceRelatedCustomerDetails
Service Eligibility: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/serviceEligibility
Start Service Finalization: Method: post
Path: /rest/apis/customer/service/startStopTransferTasks/startServiceFinalization
Validate Start Service Point 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 person records 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 queues are a list 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
Update Customer Release: Method: patch
Path: /rest/apis/common/system/installationOptions/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 Data From Bills

Billed usage quantifies the values from bill segments for service agreements for a unit of measure over time periods.

Get Billed Usage for Service Agreements: Method: post
Path: /rest/apis/customer/usage/usageData/serviceAgreementBilledUsage
Get Multi-Account Usage Summary: Method: post
Path: /rest/apis/customer/usage/usageData/multiAccountSummary
Get Single Service Usage Summary: Method: post
Path: /rest/apis/customer/usage/usageData/singleServiceSummary

Usage/Usage Transaction

Usage transactions record usage calculations that are sent for periods of time for a usage subscription. All of the calculated service quantities, often referred to as bill determinants, are provided in the usage transaction. Usage transactions can be configured to include an interval data snapshot if details are required for interval-based calculations.

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}
Update Usage Transaction Service Lifecycle Action: Method: patch
Path: /rest/apis/meter/usage/usageTransactions/{usageTransactionId}/lifecycle

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 person records.

Create Account: Method: post
Path: /rest/apis/customer/v-model/accounts/
Create Account AutoPay: Method: post
Path: /rest/apis/customer/v-model/accounts/{accountId}/autoPay
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 AutoPay: Method: delete
Path: /rest/apis/customer/v-model/accounts/{accountId}/autoPay/{autoPayId}
Delete Account Person: Method: delete
Path: /rest/apis/customer/v-model/accounts/{accountId}/persons/{personId}
Get Account: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}
Get Account Alerts: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}/alerts
Get Account AutoPay: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}/autoPay/{autoPayId}
Get Account Credit Rating History: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}/creditRatingHistory
Get Account Effective AutoPay: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}/autoPay
Get Account Non Cash Deposits: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}/nonCashDeposits
Get Account Person: Method: get
Path: /rest/apis/customer/v-model/accounts/{accountId}/persons/{personId}
Replace Account Person: Method: put
Path: /rest/apis/customer/v-model/accounts/replace/{accountId}/persons/{personId}
Update Account: Method: put
Path: /rest/apis/customer/v-model/accounts/{accountId}
Update Account AutoPay: Method: put
Path: /rest/apis/customer/v-model/accounts/{accountId}/autoPay/{autoPayId}
Update Account Person: Method: put
Path: /rest/apis/customer/v-model/accounts/{accountId}/persons/{personId}

V-Model/Billing Context

Billing context enables queries for customer criteria such as an account, person, and premise that are typically used to view related customer information.

Get Billing Account Context: Method: get
Path: /rest/apis/customer/v-model/billingContext/accountContext/{accountId}
Get Customer History for a Premise: Method: get
Path: /rest/apis/customer/v-model/billingContext/premiseCustomerHistory/{premiseId}
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

These operations support queries for person records of type business that may have multiple active billing accounts and premise service locations.

Get Business Person Summary: Method: post
Path: /rest/apis/customer/v-model/businessPersonQueries/
Get Top Overdue Accounts: Method: post
Path: /rest/apis/customer/v-model/businessPersonQueries/topOverdueAccounts

V-Model/Business Search

These operations support queries for business person records based on specific filters such as an account or service address.

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

V-Model/Communications Preferences

Communication preferences centralize the maintenance of communication preferences and notification types that are allowed for an account. Opt-out and opt-in for push notifications are for the entire account, therefore it is generally recommended to only allow updates for the person that is the main customer for the account.

Get Communication 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
Get Push Notification Details: Method: get
Path: /rest/apis/customer/v-model/communicationsPreferences/{accountId}/{notificationType}/getNotificationDetails
Patch Communication 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

Customer contacts are used to record notifications sent to customers. Notification types may reference a customer contact type that is used to create a record of notifications of that type. Notifications that originated in this application can be updated and those that originated in external systems can be added and updated for informational purposes. The customer contact log can record the status of the notification, such as if it has been delivered, opened, or bounced.

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 in other systems (such as a service request, lead, opportunity, and so on in a Customer Experience application).

Get 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. Installation events can also record the dates and times when the device has been turned on and off, or removed.

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

Landlord agreements maintain service reversion preferences for a landlord or property manager for one or more premises. If the landlord has different service reversion preferences for different premises, it is possible to have multiple landlord agreements for each set of preferences.

Create Landlord Agreement: Method: post
Path: /rest/apis/customer/v-model/landlordAgreements/
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 service retrieves notification preferences for a collection of accounts and notification types. This can be used to enable notification types that are triggered by external applications and need to be sent directly to an outbound notification system instead of initiating the notifications through this application with a Create Notifications service. For example, this can be used to for the Oracle Utilities Network Management System which is triggered by external applications and needs to be sent directly to an outbound notification system instead of initiating the notifications through this application with a Create Notifications service.

Retrieve Notification Preferences for Account: 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 or product provided. Besides customers, person records can exist for landlords or property managers, contractors, third-party guarantors, collection agencies, energy distributors or other service providers, and so on.

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 information records for an individual or business with which your company has a relationship that may also need to be managed with CX applications. Synchronized person data includes primary name and contacts, such as phone numbers or email addresses.

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

V-Model/Person Search

Search for person or business records based on criteria such as account id, service address, person identifier, and geographic value. The response includes the list of active accounts and premises associated with each matching person record.

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

V-Model/Premise

Premises contain geographic information about service address locations. 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}
Get 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

Service agreements are a service contract with a customer. The service agreement contains the terms and conditions controlling how the system calculates charges for a specific service or product or management of funds provided 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}
Search Service Agreement: 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

Search for service points based on criteria such as account, premise (address text), person, and filters such as service type.

Get Service Points for 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 service provides summary information of a service point, which can be used across both the customer application and meter application data models. When used in a combined customer to meter application data model, the summary also includes additional fields that are stored on the meter application service point.

Get Service Point Reading Details: Method: get
Path: /rest/apis/customer/v-model/servicePointsCommon/{servicePointId}/servicePointReadingDetails
Get Service Point Summary: Method: get
Path: /rest/apis/customer/v-model/servicePointsCommon/{servicePointId}/summary
Get Service Point Usage: Method: post
Path: /rest/apis/customer/v-model/servicePointsCommon/servicePointUsage
Get UOMs and Granularity Details for a Service Point: 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 a meter connection socket, at which a utility supplies service that can be used to store information describing the type of service supplied and how it is measured.

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.

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 Service Point for a 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

The operations from the V-Model/Service Points/Meter Data Management category.

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 requests for a person 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. The customer's preferences may have changed since a notification was received. For example, the user may unsubscribe from an old email. This service ensures that 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 below so that 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

Usage subscriptions manage an ongoing request to send one or more service point usage details to one or more external systems based on a calculation group defining rules and a service provider. A service provider must exist for each system that subscribes to usage calculations.

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}