Who owes whom
GET
/api/v1/balances
const url = 'http://127.0.0.1:8484/api/v1/balances';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://127.0.0.1:8484/api/v1/balances \ --header 'Authorization: Bearer <token>'For subscriptions with cost shares: what each member paid and should carry in a month, and the fewest payments that settle it.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”month
string
Responses
Section titled “Responses”OK
Media typeapplication/json
object
$schema
A URL to the JSON Schema for this object.
string format: uri
charges
required
Array<object> | null
object
amount
required
object
currency
required
string
minor
required
integer format: int64
date
required
string
paidBy
required
string
status
required
string
subscription
required
string
mainCurrency
required
string
members
required
Array<object> | null
object
memberId
required
string
name
required
string
net
required
object
currency
required
string
minor
required
integer format: int64
paid
required
object
currency
required
string
minor
required
integer format: int64
share
required
object
currency
required
string
minor
required
integer format: int64
month
required
string
transfers
required
Array<object> | null
object
amount
required
object
currency
required
string
minor
required
integer format: int64
from
required
string
text
required
string
to
required
string
Example
{ "$schema": "https://example.com/api/schemas/Balances.json"}default
Section titled “default”Error
Media typeapplication/problem+json
object
$schema
A URL to the JSON Schema for this object.
string format: uri
detail
A human-readable explanation specific to this occurrence of the problem.
string
errors
Optional list of individual error details
Array<object> | null
object
location
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
string
message
Error message text
string
value
The value at the given location
instance
A URI reference that identifies the specific occurrence of the problem.
string format: uri
status
HTTP status code
integer format: int64
title
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
string
type
A URI reference to human-readable documentation for the error.
string format: uri
Example
{ "$schema": "https://example.com/api/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}