Get financial account

GET

financial_accounts

{id}

curl --request GET \
  --url https://api.slant.app/v1/financial_accounts/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.slant.app/v1/financial_accounts/{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://api.slant.app/v1/financial_accounts/{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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.slant.app/v1/financial_accounts/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.slant.app/v1/financial_accounts/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "<string>",
  "account_type": "checking",
  "tax_advantaged_type": "not_applicable",
  "other_tax_advantaged_type_label": "<string>",
  "account_number": "<string>",
  "institution_name": "<string>",
  "balance_in_cents": 123,
  "notes": "<string>",
  "owner_ids": [
    "<string>"
  ],
  "custom_fields": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "book_id": "<string>",
  "household_id": "<string>",
  "balance_as_of": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Authorization

string

Path Parameters

string

required

Response

Successful financial resource access

string

required

name

string

account_type

enum<string>

Available options:

checking,

savings,

investment,

insurance,

unknown

tax_advantaged_type

enum<string>

Available options:

not_applicable,

hsa,

traditional_401k,

roth_401k,

traditional_ira,

roth_ira,

education_fivetwonine,

sep_ira,

simple_ira,

solo_401k,

traditional_403b,

roth_403b,

traditional_four_five_seven,

roth_four_five_seven,

pension_plan,

profit_sharing_plan,

rollover_ira,

ugma,

utma,

non_deductible_ira,

beneficiary_ira,

traditional_401a,

coverdell_esa,

inherited_ira,

unknown,

other

other_tax_advantaged_type_label

string | null

account_number

string | null

Masked account number; the full number is never returned.

institution_name

string | null

balance_in_cents

integer | null

Money in integer cents.

notes

string | null

owner_ids

string[]

Replaces this role; omit to preserve existing people.

custom_fields

object

created_at

string<date-time>

updated_at

string<date-time>

book_id

string

household_id

string

balance_as_of

string<date-time> | null

⌘I

Get financial account

curl --request GET \
  --url https://api.slant.app/v1/financial_accounts/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.slant.app/v1/financial_accounts/{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://api.slant.app/v1/financial_accounts/{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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.slant.app/v1/financial_accounts/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.slant.app/v1/financial_accounts/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "<string>",
  "account_type": "checking",
  "tax_advantaged_type": "not_applicable",
  "other_tax_advantaged_type_label": "<string>",
  "account_number": "<string>",
  "institution_name": "<string>",
  "balance_in_cents": 123,
  "notes": "<string>",
  "owner_ids": [
    "<string>"
  ],
  "custom_fields": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "book_id": "<string>",
  "household_id": "<string>",
  "balance_as_of": "2023-11-07T05:31:56Z"
}

Getting started

Endpoints

Get financial account

Authorizations

Headers

Path Parameters

Response