====== Residents ======

==== Description ====
A billing and invoicing plugin for Admidio that helps manage resident invoices, payments, recurring charges, and device registrations.

==== Features ====
  * Invoice Management - Create, edit, preview, and delete invoices for residents
  * Payment Tracking - Record and manage payments against invoices
  * Recurring Charges - Define recurring charge templates for automated billing
  * Device Management - Track and approve resident device registrations
  * Payment Gateway Integration - CCAvenue payment gateway support for online payment transactions
  * PDF Generation - Generate PDF invoices and payment receipts
  * Role-Based Access Control - Configurable admin roles for billing management
  * Mobile API - REST API endpoints for mobile app integration

==== Downloads ====


<WRAP download 60%>
{{admidioplugins>releases}}
</WRAP>


===== Installation (Admidio < 6.0) =====
<WRAP info>These steps apply to **Admidio < 6.0**, where a plugin is unpacked into the plugins folder by hand. From **Admidio 6.0** on, plugins are installed in Admidio's Plugin Manager instead - see [[en:plugins:installation|Using plugins in your homepage]].</WRAP>


  - **Download the Plugin**
    * Download the plugin from [[https://github.com/adhi-software/residents/archive/refs/tags/v1.0.zip|GitHub]]
    * Unzip the downloaded file into your Admidio plugins folder:
      <code>
      adm_plugins/residents/
      </code>

  - **Run Installation**
    * Open your browser and navigate to:
      <code>
      http://your-domain/adm_plugins/residents/installation.php
      </code>
    * Click the **Install** button to create the required database tables

  - **Configure Payment Gateway (Optional)**
    * Go to **Preferences** tab
    * Click **Add Payment Gateway** to configure **CCAvenue** for online payment transactions
    * Enter your **CCAvenue merchant credentials** (Merchant ID, Access Code, Working Key)

===== Uninstallation =====

  * Navigate to **Preferences** tab in the Residents plugin
  * Click the **Uninstall Residents** button at the bottom of the page
  * Confirm the uninstallation to remove all plugin tables and data

===== Contact Us =====

[[https://adhisoftware.co.in/|Adhi Software]] Can be contacted at info@adhisoftware.co.in

===== Version history =====
//[[https://github.com/adhi-software/residents/archive/refs/tags/v1.0.zip|residents-1.0.zip]] (10/02/2026)//
  * Invoice management
  * Payment Tracking
  * Recurring charge definitions
  * CCAvenue payment gateway integration
  * PDF generation for invoices and receipts
  * Role-based access control for billing admins
  * Mobile API endpoints
  * Device registration and approval workflow