# Get All Settlements

**Method:** `GET`

**Path:** `/api/settlements/v1/list`

**Category:** Settlements

**Authentication:** Required

## Description

Retrieves all settlements within a specified date range.

**Notes:**
- Maximum date range for retrieving settlement data is 60 days.
- API supports a maximum of 10 records per page, one page at a time.


## Query Parameters

- `start_date` (`string`) **required** — Start date for settlement retrieval.
- `end_date` (`string`) **required** — End date for settlement retrieval.
- `page` (`string`) — Page number to retrieve.
- `per_page` (`string`) — Number of records per page (max 10).

## Responses

- `200` — Settlements retrieved successfully.
- `400` — 
- `401` — 
- `500` — 

### Response Schema

- `data` (`SettlementSummary[]`) — Array of settlement summary objects.
  - `total_amount` (`number`) — Total settlement amount.
  - `actual_transaction_amount` (`number`) — Total transaction amount without deductions.
  - `total_deduction_amount` (`number`) — Total deduction amount.
  - `total_transactions_count` (`integer`) — Total number of transactions settled within this UTR.
  - `last_processed_date` (`string`) — Date when transactions were last processed for settlement.
  - `settled_date` (`string`) — Date on which the batch was settled.
  - `utr_number` (`string`) — Unique Transaction Reference generated for the settlement.
  - `programs` (`string[]`) — Payment programs included in this settlement.
  - `system` (`string`) — Constant system identifier.
  - `bank_name` (`string`) — Settlement bank name.
  - `bank_acc_number` (`string`) — Settlement bank account number.

- `total_settlement_count` (`integer`) — Total number of settlements matching the query.
- `total_transactions_count` (`integer`) — Total number of transactions across all settlements.
- `total_settlement_amount` (`number`) — Total settlement amount across all settlements.

### Example Response

```json
{
  "data": [
    {
      "total_amount": 0.96,
      "actual_transaction_amount": 2,
      "total_deduction_amount": 0.08,
      "total_transactions_count": 2,
      "last_processed_date": "2024-10-09T07:00:00",
      "settled_date": "2024-10-09T10:59:46",
      "utr_number": "410092786849",
      "programs": [
        "UPI"
      ],
      "system": "PG",
      "bank_name": "HDFC Bank Ltd",
      "bank_acc_number": "04992990009595"
    }
  ],
  "total_settlement_count": 7,
  "total_transactions_count": 14,
  "total_settlement_amount": 10.72
}
```

---

Reference: https://localhost:3000/api/settlements/get-all-settlements