# OMNL Fineract Integration

Apache Fineract API client and scripts for the **OMNL** tenancy at [https://omnl.hybxfinance.io/](https://omnl.hybxfinance.io/).

## Overview

- **Base URL:** `https://omnl.hybxfinance.io/fineract-provider/api/v1`
- **Tenant ID:** `omnl` (required header: `Fineract-Platform-TenantId: omnl`)
- **Auth:** Basic auth (username/password)

## Setup

1. Copy env template and set credentials:
   ```bash
   cp .env.example .env
   # Edit .env and set OMNL_FINERACT_PASSWORD (and other vars if needed)
   ```

2. Load env and test (from repo root or this directory):
   ```bash
   set -a && source .env && set +a
   curl -s -u "${OMNL_FINERACT_USER}:${OMNL_FINERACT_PASSWORD}" \
     -H "Fineract-Platform-TenantId: ${OMNL_FINERACT_TENANT}" \
     "${OMNL_FINERACT_BASE_URL}/offices"
   ```

## Environment Variables

| Variable | Description | Example |
|----------|-------------|---------|
| `OMNL_FINERACT_BASE_URL` | API base URL (no trailing slash) | `https://omnl.hybxfinance.io/fineract-provider/api/v1` |
| `OMNL_FINERACT_TENANT` | Tenant identifier | `omnl` |
| `OMNL_FINERACT_USER` | Basic auth username | `app.omnl` |
| `OMNL_FINERACT_PASSWORD` | Basic auth password | *(set in .env only)* |
| `OMNL_FINERACT_INSECURE` | Skip TLS verify (0/1) | `0` |

## API Quick Reference

- **Swagger UI:** [https://omnl.hybxfinance.io/fineract-provider/swagger-ui/index.html](https://omnl.hybxfinance.io/fineract-provider/swagger-ui/index.html)
- **Offices:** `GET /offices`
- **Clients:** `GET /clients`
- **Loans:** `GET /loans`

All requests require:
- Header: `Fineract-Platform-TenantId: omnl`
- Basic auth: `app.omnl` + password

## Submodule

This directory can be added as a git submodule when the OMNL Fineract integration is moved to its own repository. From the parent repo:

```bash
git submodule add <repository-url> omnl-fineract
git submodule update --init --recursive
```

## Documentation

- [OMNL Fineract Configuration](../../docs/04-configuration/OMNL_FINERACT_CONFIGURATION.md) — Full setup and credential handling
- [OMNL Deposits Plan](../../docs/04-configuration/OMNL_DEPOSITS_PLAN.md) — Plan for adding all deposits (savings/FD/RD, discovery, bulk)
- [Migration & Ledger Allocation Memorandum](../../docs/04-configuration/mifos-omnl-central-bank/MIGRATION_AND_LEDGER_ALLOCATION_MEMORANDUM.md) — Opening balance and internal USD distribution (T-001–T-008)