> For the complete documentation index, see [llms.txt](https://docs.udara360.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.udara360.io/udara360-docs-1/account/editor/balance-inquiry-extended.md).

# Balance Inquiry (Extended)

To retrieve an account's extended balance details, make a GET request to this endpoint, passing the account number as the `AccountNumber` query parameter. 

A successful request returns the account's core balances alongside accrued interest, unpaid fees, outstanding loan and overdraft amounts, and any liens or memos tied to the account.

This process allows you to get a complete financial picture of an account beyond the basic balance, useful for reconciliation or before approving a transaction.

<mark style="color:blue;">`GET`</mark> `/api/account/v1/GetExtendedBalanceByAccountNumber`

**Headers**

| Name                                                | Value                |
| --------------------------------------------------- | -------------------- |
| Content-Type<mark style="color:red;">\*</mark>      | `application/jsona`  |
| Authorization<mark style="color:red;">\*</mark>     | `bearer <token>`     |
| request-reference<mark style="color:red;">\*</mark> | `{unique_reference}` |

**Params**

| Name            | Data Type (Length) | Required | Description                                                 |
| --------------- | ------------------ | -------- | ----------------------------------------------------------- |
| `AccountNumber` | string             | Required | The account number to retrieve extended balance details for |

**Body**

| Name                          | Data Type | Description                                                  |
| ----------------------------- | --------- | ------------------------------------------------------------ |
| `accountNumber`               | string    | The account number balance details belong to                 |
| `accountName`                 | string    | The customer/account name                                    |
| `referenceNumber`             | string    | System reference number for the account                      |
| `productName`                 | string    | Name of the account product                                  |
| `accountStatus`               | string    | Current status of the account (e.g. Active, Dormant, Frozen) |
| `accountOfficerName`          | string    | Name of the account officer managing the account             |
| `accountOfficerCode`          | string    | Code identifying the account officer                         |
| `accountOfficerID`            | string    | Unique ID of the account officer                             |
| `branchName`                  | string    | Branch where the account is domiciled                        |
| `branchCode`                  | string    | Code of the branch where the account is domiciled            |
| `overdraftLimit`              | string    | Approved overdraft limit on the account                      |
| `ledgerBalance`               | string    | Full account balance including uncleared funds               |
| `availableBalance`            | string    | Balance currently available for use                          |
| `withdrawableBalance`         | string    | Balance that can actually be withdrawn                       |
| `unclearedEffect`             | string    | Total value of uncleared funds affecting the balance         |
| `overdrawnAmount`             | string    | Amount by which the account is currently overdrawn           |
| `unpaidOverdraftInterest`     | string    | Unpaid interest accrued on the overdraft                     |
| `unpaidAccountOpeningFee`     | string    | Unpaid account opening fee                                   |
| `unpaidAccountMaintenanceFee` | string    | Unpaid account maintenance fee                               |
| `unpaidCOTFee`                | string    | Unpaid Commission on Turnover (COT) fee                      |
| `unpaidOverdraftFee`          | string    | Unpaid overdraft management fee                              |
| `unpaidSMSFee`                | string    | Unpaid SMS alert fee                                         |
| `totalOutstandingOverdraft`   | string    | Total outstanding overdraft balance                          |
| `unpaidLoanPrincipal`         | string    | Unpaid principal on any loan linked to the account           |
| `unpaidLoanInterest`          | string    | Unpaid interest on any loan linked to the account            |
| `unpaidLoanFee`               | string    | Unpaid fees on any loan linked to the account                |
| `unpaidLoanPenalty`           | string    | Unpaid penalty charges on any loan linked to the account     |
| `defaultingLoanInterest`      | string    | Interest accrued due to loan default                         |
| `totalOutstandingLoan`        | string    | Total outstanding loan balance                               |
| `hasLoanOutstandingAmount`    | boolean   | Whether the account has any outstanding loan amount          |
| `accruedCOTFee`               | string    | COT fee accrued but not yet charged                          |
| `accruedSMSFee`               | string    | SMS fee accrued but not yet charged                          |
| `accruedLoanInterest`         | string    | Loan interest accrued but not yet charged                    |
| `accruedSavingsInterest`      | string    | Savings interest accrued but not yet paid out                |
| `accruedOverdraftInterest`    | string    | Overdraft interest accrued but not yet charged               |
| `totalAccruedAmount`          | string    | Sum of all accrued amounts on the account                    |
| `securityDeposit`             | string    | Security deposit held against the account                    |
| `repaymentLien`               | string    | Amount placed on lien for loan repayment                     |
| `productMinimumBalance`       | string    | Minimum balance required by the account product              |
| `totalWithheldAmount`         | string    | Total amount currently withheld on the account               |
| `percentageLien`              | string    | Lien amount calculated as a percentage of balance            |
| `flatLien`                    | string    | Lien amount applied as a flat value                          |
| `totalLien`                   | string    | Combined total of all liens on the account                   |
| `memos`                       | array     | Log of actions/notes recorded against the account            |

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

**Sample API Request**

{% tabs %}
{% tab title="Curl" %}

```javascript
curl --location -g '{{baseurl}}/api/account/v1/GetExtendedBalanceByAccountNumber?AccountNumber=1100029938' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data ''
```

{% endtab %}
{% endtabs %}

**Response**

<details>

<summary><code>200</code></summary>

```json
{
  "status": true,
  "message": "string",
  "data": {
    "accountNumber": "string",
    "accountName": "string",
    "referenceNumber": "string",
    "productName": "string",
    "accountStatus": "string",
    "accountOfficerName": "string",
    "accountOfficerCode": "string",
    "accountOfficerID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "branchName": "string",
    "branchCode": "string",
    "overdraftLimit": "string",
    "ledgerBalance": "string",
    "availableBalance": "string",
    "withdrawableBalance": "string",
    "unclearedEffect": "string",
    "overdrawnAmount": "string",
    "unpaidOverdraftInterest": "string",
    "unpaidAccountOpeningFee": "string",
    "unpaidAccountMaintenanceFee": "string",
    "unpaidCOTFee": "string",
    "unpaidOverdraftFee": "string",
    "unpaidSMSFee": "string",
    "totalOutstandingOverdraft": "string",
    "unpaidLoanPrincipal": "string",
    "unpaidLoanInterest": "string",
    "unpaidLoanFee": "string",
    "unpaidLoanPenalty": "string",
    "defaultingLoanInterest": "string",
    "totalOutstandingLoan": "string",
    "hasLoanOutstandingAmount": true,
    "accruedCOTFee": "string",
    "accruedSMSFee": "string",
    "accruedLoanInterest": "string",
    "accruedSavingsInterest": "string",
    "accruedOverdraftInterest": "string",
    "totalAccruedAmount": "string",
    "securityDeposit": "string",
    "repaymentLien": "string",
    "productMinimumBalance": "string",
    "totalWithheldAmount": "string",
    "percentageLien": "string",
    "flatLien": "string",
    "totalLien": "string",
    "memos": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "dateCreated": "2025-01-20T09:42:08.220Z",
        "dateLastModified": "2025-01-20T09:42:08.220Z",
        "initiatedBy": "string",
        "accountNumber": "string",
        "actionType": "string",
        "details": "string",
        "comments": "string",
        "status": "string",
        "lastModifiedBy": "string"
      }
    ]
  }
}
```

</details>