Integration

Oracle Utilities REST API for Metering and Customer Information

This documentation helps you to get started using the REST APIs for Oracle Utilities Metering and Customer Information.

Open Swagger Explorer Download OpenAPI JSON

OperationsOpenAPI 3.0.0 · v2022.03.24 · 144 operations · 86 paths

Credit & Collections/Collection Process3 operations

POST/spl/rest/apis/customer/collections/collectionProcesss

Create collection Process

GET/spl/rest/apis/customer/collections/collectionProcesss/{collectionProcessId}

Get Collection Process

PUT/spl/rest/apis/customer/collections/collectionProcesss/{collectionProcessId}

Update Collection Process

Credit & Collections/Cut Process3 operations

PATCH/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}/action

Action Cut Process

GET/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}

Get Cut Process

PUT/spl/rest/apis/customer/collections/cutProcesses/{cutProcessId}

Update Cut Process

Credit & Collections/Overdue Process4 operations

PATCH/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}/action

Action Overdue Process

GET/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}

Get Overdue Process

PUT/spl/rest/apis/customer/collections/overdueProcesses/{overdueProcessId}

Update Overdue Process

POST/spl/rest/apis/customer/collections/overdueProcesses

Create Overdue Process

Credit & Collections/Severance Process3 operations

POST/spl/rest/apis/customer/collections/severanceProcesses

Create Severance Process

GET/spl/rest/apis/customer/collections/severanceProcesses/{severanceProcessId}

Get Severance Process

PUT/spl/rest/apis/customer/collections/severanceProcesses/{severanceProcessId}

Update Severance Process

Credit & Collections/Write Off Process3 operations

POST/spl/rest/apis/customer/collections/writeoffProcesses

Create Write Off Process

GET/spl/rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}

Get Write Off Process

PUT/spl/rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}

Update Write Off Process

Devices/Device Configurations4 operations

POST/ouaf/rest/apis/meter/devices/deviceConfigurations

create Device Configuration

GET/ouaf/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}

Get Device Configuration

PUT/ouaf/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}

Update Device Configuration

DELETE/ouaf/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}

Delete Device Configuration

Devices/Item4 operations

POST/ouaf/rest/apis/meter/devices/items

Create Item

GET/ouaf/rest/apis/meter/devices/items/{itemId}

Get Item

PUT/ouaf/rest/apis/meter/devices/items/{itemId}

Update Item

DELETE/ouaf/rest/apis/meter/devices/items/{itemId}

Delete Item

Devices/Measuring Component4 operations

POST/ouaf/rest/apis/meter/devices/measuringComponents

Create Measuring Component

GET/ouaf/rest/apis/meter/devices/measuringComponents/{measuringComponentId}

Get Measuring Component

PUT/ouaf/rest/apis/meter/devices/measuringComponents/{measuringComponentId}

Update Measuring Component

DELETE/ouaf/rest/apis/meter/devices/measuringComponents/{measuringComponentId}

Delete Measuring Component

Devices/Meter4 operations

POST/ouaf/rest/apis/meter/devices/meters

Create Meter

GET/ouaf/rest/apis/meter/devices/meters/{meterId}

Get Meter Details

PUT/ouaf/rest/apis/meter/devices/meters/{meterId}

Update Meter

DELETE/ouaf/rest/apis/meter/devices/meters/{meterId}

Delete Meter

Financial Transactions/Account Financial History1 operations

GET/spl/rest/apis/customer/financials/accountFinancialHistory/{accountId}

Get Account Financial History

Financial Transactions/Adjustment5 operations

GET/spl/rest/apis/customer/financials/adjustments/{adjustmentId}

Get Adjustment

PUT/spl/rest/apis/customer/financials/adjustments/{adjustmentId}

Update Adjustment

PATCH/spl/rest/apis/customer/financials/adjustments/{adjustmentId}

Action Adjustment

DELETE/spl/rest/apis/customer/financials/adjustments/{adjustmentId}

Delete Adjustment

POST/spl/rest/apis/customer/financials/adjustments

Create Adjustment

Financial Transactions/Bill5 operations

PATCH/spl/rest/apis/customer/financials/bills/{billId}/action

Action Bill

POST/spl/rest/apis/customer/financials/bills

Create Bill

GET/spl/rest/apis/customer/financials/bills/{billId}

Get Bill

PUT/spl/rest/apis/customer/financials/bills/{billId}

Update Bill

DELETE/spl/rest/apis/customer/financials/bills/{billId}

Delete Bill

Financial Transactions/Bill Segment5 operations

PATCH/spl/rest/apis/customer/financials/billSegments/{billSegmentId}/action

Action Bill Segment

POST/spl/rest/apis/customer/financials/billSegments

Create Bill Segment

GET/spl/rest/apis/customer/financials/billSegments/{billSegmentId}

Get Bill Segment

PUT/spl/rest/apis/customer/financials/billSegments/{billSegmentId}

Update Bill Segment

DELETE/spl/rest/apis/customer/financials/billSegments/{billSegmentId}

Delete Bill Segment

Financial Transactions/Budget2 operations

GET/spl/rest/apis/customer/financials/budgets/{accountId}

Get Budget

PATCH/spl/rest/apis/customer/financials/budgets/{accountId}/action

Action Budget

Financial Transactions/Pay Plan3 operations

POST/spl/rest/apis/customer/financials/payPlans

Create Pay Plan

GET/spl/rest/apis/customer/financials/payPlans/{payPlanId}

Get Pay Plan

PUT/spl/rest/apis/customer/financials/payPlans/{payPlanId}

Update Pay Plan

Financial Transactions/Payment5 operations

PATCH/spl/rest/apis/customer/financials/payments/{paymentId}/action

Action Payment

POST/spl/rest/apis/customer/financials/payments

Create Payment

GET/spl/rest/apis/customer/financials/payments/{paymentId}

Get Payment

PUT/spl/rest/apis/customer/financials/payments/{paymentId}

Update Payment

DELETE/spl/rest/apis/customer/financials/payments/{paymentId}

Delete Payment

Financial Transactions/Payment Event5 operations

PATCH/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}/action

Action Payment Event

POST/spl/rest/apis/customer/financials/paymentEvents

Create Payment Event

GET/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}

Get Payment Event

PUT/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}

Update Payment Event

DELETE/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}

Delete Payment Event

Financial Transactions/PaymentTender4 operations

PATCH/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}/action

Action Payment Tender

GET/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}

Get Payment Tender

PUT/spl/rest/apis/customer/financials/paymentTenders/{paymentTenderId}

Update Payment Tender

POST/spl/rest/apis/customer/financials/paymentTenders

Create Payment Tender

Interactions/Case6 operations

PATCH/spl/rest/apis/customer/interactions/cases/{caseId}/action

Action Case

POST/spl/rest/apis/customer/interactions/cases

Create Case

GET/spl/rest/apis/customer/interactions/cases/{caseId}

Get Case

PUT/spl/rest/apis/customer/interactions/cases/{caseId}

Update Case

DELETE/spl/rest/apis/customer/interactions/cases/{caseId}

Delete Case

GET/spl/rest/apis/customer/interactions/cases/search/case

Search Case

Interactions/Customer Activity History1 operations

GET/spl/rest/apis/customer/interactions/customerActivityHistory/{accountId}

Get Customer Activity History

Interactions/Customer Contact4 operations

POST/spl/rest/apis/customer/interactions/customerContacts

Create Customer Contact

GET/spl/rest/apis/customer/interactions/customerContacts/{customerContactId}

Get Customer Contact

PUT/spl/rest/apis/customer/interactions/customerContacts/{customerContactId}

Update Customer Contact

DELETE/spl/rest/apis/customer/interactions/customerContacts/{customerContactId}

Delete Customer Contact

Service/Web User4 operations

POST/spl/rest/apis/customer/service/webUsers

Create Web User

GET/spl/rest/apis/customer/service/webUsers/{webUserId}

Get Web User

PUT/spl/rest/apis/customer/service/webUsers/{webUserId}

Update Web User

DELETE/spl/rest/apis/customer/service/webUsers/{webUserId}

Delete Web User

Service/Web User Account6 operations

POST/spl/rest/apis/customer/service/webUserAccounts

Create Web User Account

GET/spl/rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}

Get Web User Account

PUT/spl/rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}

Update Web User Account

DELETE/spl/rest/apis/customer/service/webUserAccounts/{webUserId}/{accountId}

Delete Web User Account

GET/spl/rest/apis/customer/service/webUserAccounts/{webUserId}

Search Web User Accounts

GET/spl/rest/apis/customer/service/webUserAccounts/{accountId}/accountVerificationInfo

Get Account Verification Details

Service/Work Queue1 operations

GET/spl/rest/apis/customer/service/workQueue

Get Work Queue

Usage/Usage Transaction5 operations

PATCH/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}/action

Patch Usage Transaction

POST/ouaf/rest/apis/meter/usage/usageTransactions

Create Usage Transaction

GET/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}

Get Usage Transaction

PUT/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}

Update Usage Transaction

DELETE/ouaf/rest/apis/meter/usage/usageTransactions/{usageTransactionId}

Delete Usage Transaction

V-Model/Account4 operations

POST/spl/rest/apis/customer/v-model/accounts

Create Account

GET/spl/rest/apis/customer/v-model/accounts/{accountId}

Get Account

PUT/spl/rest/apis/customer/v-model/accounts/{accountId}

Update Account

DELETE/spl/rest/apis/customer/v-model/accounts/{accountId}

Delete Account

V-Model/Business Person Queries2 operations

POST/spl/rest/apis/cross/v-model/businessPersonQueries

Business Person Summary

POST/spl/rest/apis/cross/v-model/businessPersonQueries/personSearch

Business Person Search

V-Model/Communications Preferences4 operations

GET/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}

Get Communications Preferences

PATCH/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}

Patch Communications Preferences

GET/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses

Get Mailing Addresses

PATCH/spl/rest/apis/customer/v-model/communicationsPreferences/{accountId}/{personId}/addresses

Update Mailing Address

V-Model/Install Events4 operations

POST/ouaf/rest/apis/meter/v-model/installEvents

Create Install Event

GET/ouaf/rest/apis/meter/v-model/installEvents/{installEventId}

Get Install Event

PUT/ouaf/rest/apis/meter/v-model/installEvents/{installEventId}

Update Install Event Details

DELETE/ouaf/rest/apis/meter/v-model/installEvents/{installEventId}

Delete Install Event Details

V-Model/Landlord Agreements4 operations

POST/spl/rest/apis/customer/v-model/landlordAgreements

Create Landlord Agreement

GET/spl/rest/apis/customer/v-model/landlordAgreements/{landLordId}

Get Landlord Agreement

PUT/spl/rest/apis/customer/v-model/landlordAgreements/{landLordId}

Update Landlord Agreement

DELETE/spl/rest/apis/customer/v-model/landlordAgreements/{landLordId}

Delete Landlord Agreement

V-Model/Person4 operations

POST/spl/rest/apis/customer/v-model/persons

Create Person

GET/spl/rest/apis/customer/v-model/persons/{personId}

Get Person

PUT/spl/rest/apis/customer/v-model/persons/{personId}

Update Person

DELETE/spl/rest/apis/customer/v-model/persons/{personId}

Delete Person

V-Model/Person Context1 operations

GET/spl/rest/apis/customer/v-model/personContext/{personId}

Get Person Context

V-Model/Person Information Synchronization1 operations

PUT/spl/rest/apis/customer/v-model/cxPersons/{cxContactId}

Sync Person

V-Model/Premise4 operations

POST/spl/rest/apis/customer/v-model/premises

Create Premise

GET/spl/rest/apis/customer/v-model/premises/{premiseId}

Get Premise

PUT/spl/rest/apis/customer/v-model/premises/{premiseId}

Update Premise

DELETE/spl/rest/apis/customer/v-model/premises/{premiseId}

Delete Premise

V-Model/Program Context1 operations

GET/spl/rest/apis/cross/v-model/programContexts/{accountId}/{personId}

Get Program Contexts

V-Model/Service Agreement4 operations

POST/spl/rest/apis/customer/v-model/serviceAgreements

Create Service Agreement

GET/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}

Get Service Agreement

PUT/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}

Update Service Agreement

DELETE/spl/rest/apis/customer/v-model/serviceAgreements/{serviceAgreementId}

Delete Service Agreement

V-Model/Service Points/C2M4 operations

POST/spl/rest/apis/cross/v-model/servicePoints

Create Service Point

GET/spl/rest/apis/cross/v-model/servicePoints/{servicePointId}

Get Service Point

PUT/spl/rest/apis/cross/v-model/servicePoints/{servicePointId}

Update Service Point

DELETE/spl/rest/apis/cross/v-model/servicePoints/{servicePointId}

Delete Service Point

V-Model/Service Points/CC&B4 operations

POST/spl/rest/apis/customer/v-model/servicePoints

Create Service Point

GET/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}

Get Service Point

PUT/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}

Update Service Point

DELETE/spl/rest/apis/customer/v-model/servicePoints/{servicePointId}

Delete Service Point

V-Model/Service Points/MDM4 operations

POST/ouaf/rest/apis/meter/v-model/servicePoints

Create Service Point

GET/ouaf/rest/apis/meter/v-model/servicePoints/{servicePointId}

Get Service Point

PUT/ouaf/rest/apis/meter/v-model/servicePoints/{servicePointId}

Update Service Point

DELETE/ouaf/rest/apis/meter/v-model/servicePoints/{servicePointId}

Delete Service Point

V-Model/Usage Subscription4 operations

POST/ouaf/rest/apis/meter/v-model/usageSubscriptions

Create Usage Subscription

GET/ouaf/rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}

Get Usage Subscription

PUT/ouaf/rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}

Update Usage Subscription

DELETE/ouaf/rest/apis/meter/v-model/usageSubscriptions/{usageSubscriptionId}

Delete Usage Subscription

V-Model/V Model Relationships1 operations

GET/spl/rest/apis/cross/v-model/vModelRelationships/{accountId}

Get V Model Relationship