cross group balances

Get balance breakdown

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

get/cross-group-balances/breakdown/{otherUserId}

Request

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

Path parameters

otherUserIdstring required

UUID of the other user to get breakdown for

Query parameters

currencystring

Which currency to detail. Defaults to the largest debt; every currency is returned in breakdownByCurrency regardless.

Response

Balance breakdown retrieved successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.