---
title: "Get Balance"
method: GET
path: "/api/partners/balance"
tags: ["Partners"]
---

# Get Balance

`GET /api/partners/balance`

## Request

- Base URL: `https://api.earmarkiq.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.earmarkiq.app/api/partners/balance`
- Auth: HTTP bearer

Net position across unsettled splits, from the caller's side.

Derived from the rows on every request rather than stored, so it
cannot drift from them: adding, settling or editing a split changes
the answer immediately and there is no second copy to keep in step.

Settled rows are excluded — settling means "we have squared this up
between us", so a settled split is no longer outstanding. Rows with no
recorded payer are excluded too and counted in `needs_payer`.

## Response `200`

Successful Response

- BalanceResponse: Who owes whom, over unsettled splits with a known payer.
  - `net` number, required
  - `direction` string, required
  - `unsettled_count` integer, required
  - `needs_payer` integer, required

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)