API Definitions of UBS Microservices

This portal provides detailed technical definitions, usage guidelines, and endpoint references for the key microservices that power the Utility Billing System (UBS).

Each microservice is designed to handle specific utility billing operations, enabling seamless integration between field devices, backend services, and customer-facing platforms.

Available Microservices

🔹 Email Notification Service

Enables the sending of customized email notifications, including attachments, customer bills, and alerts via RESTful endpoints. Supports validation, formatting, and delivery tracking through providers like SendGrid.

🔹 SMS Notification Service

Provides REST APIs for sending SMS alerts to customers. Useful for delivering bill summaries, reminders, and urgent notifications. Includes support for retries, delivery status, and localized message formats.

🔹 RO Helper Service

Facilitates field operations by supporting Reading Officers (ROs) in retrieving walking paths, billing cycle data, and customer profiles. Ensures real-time data sync between HHU devices and backend systems.