Retrieve a balance history record

curl --request GET \
  --url https://app.sure.am/api/v1/balances/{id} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.sure.am/api/v1/balances/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sure.am/api/v1/balances/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sure.am/api/v1/balances/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/balances/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "currency": "<string>",
  "flows_factor": 123,
  "balance": "<string>",
  "balance_cents": 123,
  "start_balance": "<string>",
  "start_balance_cents": 123,
  "end_balance": "<string>",
  "end_balance_cents": 123,
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cash_balance": "<string>",
  "cash_balance_cents": 123,
  "start_cash_balance": "<string>",
  "start_cash_balance_cents": 123,
  "start_non_cash_balance": "<string>",
  "start_non_cash_balance_cents": 123,
  "cash_inflows": "<string>",
  "cash_inflows_cents": 123,
  "cash_outflows": "<string>",
  "cash_outflows_cents": 123,
  "non_cash_inflows": "<string>",
  "non_cash_inflows_cents": 123,
  "non_cash_outflows": "<string>",
  "non_cash_outflows_cents": 123,
  "net_market_flows": "<string>",
  "net_market_flows_cents": 123,
  "cash_adjustments": "<string>",
  "cash_adjustments_cents": 123,
  "non_cash_adjustments": "<string>",
  "non_cash_adjustments_cents": 123,
  "end_cash_balance": "<string>",
  "end_cash_balance_cents": 123,
  "end_non_cash_balance": "<string>",
  "end_non_cash_balance_cents": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

GET

api

balances

{id}

Retrieve a balance history record

curl --request GET \
  --url https://app.sure.am/api/v1/balances/{id} \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.sure.am/api/v1/balances/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sure.am/api/v1/balances/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sure.am/api/v1/balances/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/balances/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2023-12-25",
  "currency": "<string>",
  "flows_factor": 123,
  "balance": "<string>",
  "balance_cents": 123,
  "start_balance": "<string>",
  "start_balance_cents": 123,
  "end_balance": "<string>",
  "end_balance_cents": 123,
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "account_type": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "cash_balance": "<string>",
  "cash_balance_cents": 123,
  "start_cash_balance": "<string>",
  "start_cash_balance_cents": 123,
  "start_non_cash_balance": "<string>",
  "start_non_cash_balance_cents": 123,
  "cash_inflows": "<string>",
  "cash_inflows_cents": 123,
  "cash_outflows": "<string>",
  "cash_outflows_cents": 123,
  "non_cash_inflows": "<string>",
  "non_cash_inflows_cents": 123,
  "non_cash_outflows": "<string>",
  "non_cash_outflows_cents": 123,
  "net_market_flows": "<string>",
  "net_market_flows_cents": 123,
  "cash_adjustments": "<string>",
  "cash_adjustments_cents": 123,
  "non_cash_adjustments": "<string>",
  "non_cash_adjustments_cents": 123,
  "end_cash_balance": "<string>",
  "end_cash_balance_cents": 123,
  "end_non_cash_balance": "<string>",
  "end_non_cash_balance_cents": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "details": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

Authorizations

X-Api-Key

string

header

required

API key for authentication. Generate one from your account settings.

Path Parameters

string<uuid>

required

Balance ID

Response

balance retrieved

string<uuid>

required

date

string<date>

required

currency

string

required

flows_factor

number<float>

required

balance

string

required

balance_cents

integer

required

Balance in currency minor units

start_balance

string

required

start_balance_cents

integer

required

Starting total balance in currency minor units

end_balance

string

required

end_balance_cents

integer

required

Ending total balance in currency minor units

account

object

required

Show child attributes

created_at

string<date-time>

required

updated_at

string<date-time>

required

cash_balance

string | null

cash_balance_cents

integer | null

Cash balance in currency minor units

start_cash_balance

string

start_cash_balance_cents

integer

Starting cash balance in currency minor units

start_non_cash_balance

string

start_non_cash_balance_cents

integer

Starting non-cash balance in currency minor units

cash_inflows

string

cash_inflows_cents

integer

Cash inflows in currency minor units

cash_outflows

string

cash_outflows_cents

integer

Cash outflows in currency minor units

non_cash_inflows

string

non_cash_inflows_cents

integer

Non-cash inflows in currency minor units

non_cash_outflows

string

non_cash_outflows_cents

integer

Non-cash outflows in currency minor units

net_market_flows

string

net_market_flows_cents

integer

Net market flows in currency minor units

cash_adjustments

string

cash_adjustments_cents

integer

Cash adjustments in currency minor units

non_cash_adjustments

string

non_cash_adjustments_cents

integer

Non-cash adjustments in currency minor units

end_cash_balance

string

end_cash_balance_cents

integer

Ending cash balance in currency minor units

end_non_cash_balance

string

end_non_cash_balance_cents

integer

Ending non-cash balance in currency minor units

⌘I

Auth

Accounts

Balance Sheet

Balances

Budget Categories

Budgets

Categories

Chats

Family Exports

Family Settings

Holdings

Import Sessions

Imports

Merchants

Provider Connections

Recurring Transactions

Rejected Transfers

Rule Runs

Rules

Securities

Security Prices

Sync

Tags

Trades

Transactions

Transfers

Valuations

Users

Retrieve a balance history record

Authorizations

Path Parameters

Response