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

# Get settlement preview

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

## Request

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

Get settlement preview without committing to any transactions

## Path parameters

- `groupId` string, required

## Response `200`

Settlement preview retrieved successfully

- object
  - `data` GroupSettlementPreviewResponseDto
    - `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
    - `previewOnly` boolean, required: Indicates this is a preview only
  - `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)