---
title: "Get balance breakdown"
method: GET
path: "/cross-group-balances/breakdown/{otherUserId}"
tags: ["cross group balances"]
---

# Get balance breakdown

`GET /cross-group-balances/breakdown/{otherUserId}`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/cross-group-balances/breakdown/{otherUserId}`
- Auth: HTTP bearer

Get detailed breakdown showing which groups contribute to the consolidated balance with a specific user

## Path parameters

- `otherUserId` string, required

## Query parameters

- `currency` string

## Response `200`

Balance breakdown retrieved successfully

- object
  - `data` BalanceBreakdownResponseDto
    - `otherUserId` string, required: ID of the other user in the relationship
    - `otherUserDisplayName` string, required: Display name of the other user
    - `netAmount` number, required: Net amount across all groups
    - `currency` string, required: Currency of the net amount
    - `groups` BalanceBreakdownGroupResponseDto[], required: Detailed breakdown by group
      - `groupId` string, required: ID of the group
      - `groupName` string, required: Name of the group
      - `settlementAmount` number, required: Settlement amount from this group
      - `currency` string, required: Currency of the settlement amount
      - `settlementTransaction` object: Details of the settlement transaction
        - `from` string
        - `to` string
        - `amount` number
  - `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)