---
title: "Get detailed settlement analysis"
method: GET
path: "/groups/{groupId}/settlement/analysis"
tags: ["settlements"]
---

# Get detailed settlement analysis

`GET /groups/{groupId}/settlement/analysis`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/groups/{groupId}/settlement/analysis`
- Auth: HTTP bearer

Get detailed settlement analysis including metrics and validation

## Path parameters

- `groupId` string, required

## Response `200`

Settlement analysis retrieved successfully

- object
  - `data` SettlementAnalysisResponseDto
    - `settlement` GroupSettlementResponseDto, required
      - `groupId` string, required: Group ID
      - `transactionsByCurrency` object, required: Settlement transactions organized by currency
      - `totalTransactions` number, required: Total number of settlement transactions across all currencies
      - `currenciesUsed` string[], required: All currencies used in settlements
      - `defaultCurrency` string: Default currency for display
    - `metrics` SettlementAnalysisMetricsDto, required
      - `totalDebt` number, required: Total debt amount in the group
      - `transactionCount` number, required: Number of transactions needed
      - `averageTransactionAmount` number, required: Average transaction amount
      - `maxTransactionAmount` number, required: Maximum single transaction amount
      - `minTransactionAmount` number, required: Minimum single transaction amount
      - `efficiencyRating` number, required: Efficiency rating of the settlement
    - `isValid` boolean, required: Whether the settlement is valid
    - `originalBalances` OriginalBalanceEntryDto[], required: Original balances before settlement
      - `userId` string, required: User ID
      - `balance` number, required: Net balance after settlement
      - `userName` string: Display name
  - `success` boolean
  - `message` string

## Other responses

- `400`: Bad Request - Invalid input or validation failed
- `401`: Unauthorized - Authentication required or invalid token
- `403`: Forbidden - Insufficient permissions to access this resource
- `404`: Not Found - The requested resource does not exist
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/spliteo/apis/spliteo-api.md) · [All operations](https://skmtc.dev/spliteo/apis/spliteo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spliteo/apis/spliteo-api/revisions/bd9b84f4e407?raw)