---
title: "Preview settlement"
method: POST
path: "/settlements/cross-group/preview"
tags: ["cross group settlements"]
---

# Preview settlement

`POST /settlements/cross-group/preview`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/settlements/cross-group/preview`
- Auth: HTTP bearer

Preview cross-group settlement between two users

## Request body

- CrossGroupSettlementPreviewRequestDto
  - `userId` string, required: User ID requesting the settlement
  - `otherUserId` string, required: Other user ID in the settlement
  - `groupIds` string[]: List of group IDs to include (optional)

## Response `200`

Settlement preview calculated successfully

- object
  - `data` object, nullable
  - `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)