Get Account Balances

get/v1/account-balances/{account_balance_id}

Fetches a single account balance by its public id within the active workspace. Read only, no side effects. Returns 404 when the id is unknown or falls outside the caller's workspace scope.

Requires a bearer token: Authorization: Bearer <token>.

Path parameters

Name	Type	Required	Description
account_balance_id	string <uuid>	Yes	Public UUID of the account balance.e.g. c3d4e5f6-0000-4000-8000-0000000000a3

Query parameters

Name	Type	Required	Description
workspaceId	string <uuid>	No	Explicit workspace scope. The authenticated user must hold an active membership in this workspace. Defaults to the session workspace when omitted.e.g. a1b2c3d4-0000-4000-8000-000000000001

Request

cURL

curl -X GET https://api.wellapp.ai/v1/account-balances/{account_balance_id} \
  -H "Authorization: Bearer $WELL_API_TOKEN"

Responses

200 — The requested account balance.

{
  "data": {
    "type": "account_balance",
    "id": "c3d4e5f6-0000-4000-8000-0000000000a3",
    "attributes": {
      "account_balance_id": "c3d4e5f6-0000-4000-8000-0000000000a3",
      "accounting_balance": {
        "closing_booked": {
          "amount": 182340.18,
          "currency": "USD"
        }
      },
      "balance_at_from": "2026-04-26T00:00:00Z",
      "balance_at_to": "2026-04-27T00:00:00Z",
      "calculated_balance_diff": 4820.5,
      "expected_balance_diff": 4820.5,
      "foreign_exchange": null,
      "verified_at": "2026-04-27T03:00:00Z",
      "verification_error": false,
      "verification_error_detail": null,
      "created_at": "2026-04-27T03:00:05Z",
      "updated_at": "2026-04-27T03:00:05Z",
      "deleted_at": null
    },
    "relationships": {
      "account": {
        "data": {
          "type": "Account",
          "id": "00000000-0000-4000-8000-000000000001"
        }
      },
      "transactions": {
        "data": [
          {
            "type": "Transaction",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        ]
      }
    }
  }
}

401 — Unauthorized

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

404 — Not found

{
  "code": "NOT_FOUND",
  "status": 404,
  "title": "Not Found",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}