Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Establishing a Connection
• Testing the REST APIs
  • Using TryItOut in Oracle Utilites Application
  • Managing REST API Requests and Responses Using REST Clients
  • Using cURL to Test Your Send Requests
• Reference
  • Status Codes
  • Guaranteed Delivery
  • Supported Methods
  • JSON Format and Guidelines
  • Querying for Data with POSTs

Tasks

• Admin
  • Dropdown Lists
    • Retrieve Dropdown Lists
  • Extendable Lookup Values
    • Get Extendable Lookup Values
  • Rates
    • Search Rate Schedules
  • Service Agreement Type
    • Search SA Types
• Batch Services
  • Batch Job Submission
    • Cancel Batch Job
    • Get Batch Job / Batch Run Details
    • Submit Batch Job
• Credit & Collections
  • Collection Process
    • Get Collection Process
  • Cut Process
    • Get Cut Process
  • Overdue Process
    • Get Overdue Process
  • Severance Process
    • Get Severance Process
  • Write Off Process
    • Get Write Off Process
• Data Synchronization
  • Master Data Synchronization
    • Update Sync Request
  • Update Service Call Communication
    • Update Service Call Communication
• Devices
  • Device Configurations
    • create Device Configuration
    • Delete Device Configuration
    • Get Device Configuration
    • Update Device Configuration
  • Item
    • Create Item
    • Delete Item
    • Get Item
    • Update Item
  • Measuring Component
    • Create Measuring Component
    • Delete Measuring Component
    • Get Measuring Component
    • Update Measuring Component
  • Meter
    • Create Meter
    • Delete Meter
    • Get Meter Details
    • Update Meter
• Financial Transactions
  • Adjustment
    • Action Adjustment
    • Adjustment Summary
    • Create Adjustment
    • Delete Adjustment
    • Get Adjustment
  • AP Check Request
    • AP Check Request Maintenance
  • Bill
    • Action Bill
    • Bill Summary
    • Create Bill
    • Delete Bill
    • Get Bill
    • Search Bills
  • Bill Segment
    • Action Bill Segment
    • Bill Segment Search
    • Bill Segment Summary
    • Create Bill Segment
    • Delete Bill Segment
    • Get Bill Segment
  • Budget
    • Action Budget
    • Get Budget
  • Financial data for Accounts
    • Account Financial Statistics
    • Get Account Collection Details
    • Get Account Financial Details
    • Get Account Financial History
    • Multi-Account Billing Statistics
  • Pay Plan
    • Create Pay Plan
    • Get Pay Plan
  • Payment
    • Action Payment
    • Create Payment
    • Delete Payment
    • Get Pay Segments
    • Get Payment
    • Get Payment Summary
  • Payment Event
    • Action Payment Event
    • Create Payment Event
    • Delete Payment Event
    • Get Payment Event
    • Search Payment Event Payments
  • PaymentTender
    • Action Payment Tender
    • Create Payment Tender
    • Get Payment Tender
  • Person Financial Data
    • Person Accounts Collection Details
    • Person Collection Details
  • SA data
    • SA UOMs and Financial Statistics
• Interactions
  • Case
    • Action Case
    • Create Case
    • Delete Case
    • Get Case
    • Search Case
    • Update Case
  • Customer Activity History
    • Get Customer Activity History
  • Customer Contact
    • Create Customer Contact
    • Delete Customer Contact
    • Get Customer Contact
    • Update Customer Contact
  • Premise Activity History
    • Get Premise Activity History
• Service
  • Appointment Tasks
    • Book Appointment
    • Cancel Appointment
    • Retrieve Pending Tasks
    • Search Appointment Slots
    • Search For Tasks
  • Start Stop Transfer Tasks
    • Clear Other Person
    • Deposit Assessment
    • Determine Services To Start
    • Determine Services To Stop
    • Process Other Person
    • Process Services To Start
    • Process Services To Stop
    • Retrieve Request Type Details
    • Retrieve Service-Related Customer Details
    • Retrieve Services To Stop
    • Service Eligibility
    • Service Questions
    • Start Service Finalization
    • Stop Service Finalization
    • Transfer Service Finalization
    • Validate Start SP Selection
    • Validate Stop Service Agreement Selection
  • Web User
    • Create Web User
    • Delete Web User
    • Get Web User
    • Update Web User
  • Web User Account
    • Create Web User Account
    • Delete Web User Account
    • Get Account Verification Details
    • Get Web User Account
    • Search Web User Accounts
    • Update Web User Account
  • Work Queue
    • Get Work Queue
• System Services
  • Expand Tree
    • Expand Tree Node
  • Insights
    • Retrieve Insights
  • Installation Options
    • Get Customer Release
    • Update Customer Release
• To Do Entries
  • To Do Entry
    • Assign Next To Do Entry
    • Get To Do Entry
    • Get To Do Entry Logs
• Usage
  • Usage data from Bills
    • Billed Usage for SA
    • Multi-Account Usage Summary for a date range
    • Single Service Usage Summary for a date range
  • Usage Transaction
    • Action Usage Transaction Service
    • Create Usage Transaction
    • Delete Usage Transaction
    • Get Usage Transaction
    • Update Usage Transaction
• V-Model
  • Account
    • Create Account
    • Create Account Person
    • Delete Account
    • Delete Account Person
    • Get Account
    • Get Account Person
    • Update Account
    • Update Account Person
  • Billing Context
    • Customer History for a Premise
    • Get Billing Account Context
    • Get Person Accounts
    • Search Account Premises
    • Search Person Accounts
  • Business Person Queries
    • Business Person Summary
  • Business Search
    • Business Search
  • Communications Preferences
    • Get Communications Preferences
    • Get Mailing Addresses
    • Patch Communications Preferences
    • Update Mailing Address
  • Create
    • Update Customer Contact
      • Create Update Customer Contact
  • Entity References
    • Entity References Summary
  • Install Events
    • Create Install Event
    • Delete Install Event Details
    • Get Install Event
    • Update Install Event Details
  • Landlord Agreements
    • Create Landlord Agreement
    • Delete Landlord Agreement
    • Get Landlord Agreement
    • Update Landlord Agreement
  • Notification Preferences for Accounts
    • Retrieve Notification Preferences for Accounts
  • Person
    • Create Person
    • Delete Person
    • Get Person
    • Person Search
    • Update Person
  • Person Information Synchronization
    • Sync Person
  • Person Search
    • Person Search
  • Premise
    • Create Premise
    • Delete Premise
    • Get Premise
    • Premise Statistics
    • Search Premises
    • Update Premise
  • Service Agreement
    • Create Service Agreement
    • Delete Service Agreement
    • Get Service Agreement
    • SA Search
    • Update Service Agreement
  • Service Point Search
    • Retrieve Service Points Info corresponding to a Premise
    • Search Service Point
  • Service Points
    • Customer Care and Billing
      • Create Service Point
      • Delete Service Point
      • Get Service Point
      • Update Service Point
    • Customer to Meter
      • Create Service Point
      • Delete Service Point
      • Get Service Point
      • Search SP for Premise
      • Update Service Point
    • Meter Data Management
      • Create Service Point
      • Delete Service Point
      • Get Service Point
      • Update Service Point
  • Service Points Common
    • Get Service Point Summary
    • Retrieve SP Usage
    • Retrieve UOMs and granularity details for SP
  • Unsubscribe Notifications
    • Unsubscribe Notifications
  • Usage Subscription
    • Create Usage Subscription
    • Delete Usage Subscription
    • Get Usage Subscription
    • Update Usage Subscription