curl --request GET \
--url https://api.sandbox.teal.dev/v0/reports/balance-sheet/range \
--header 'Authorization: Bearer <token>' \
--header 'teal-instance-id: <teal-instance-id>'import requests
url = "https://api.sandbox.teal.dev/v0/reports/balance-sheet/range"
headers = {
"teal-instance-id": "<teal-instance-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'teal-instance-id': '<teal-instance-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.sandbox.teal.dev/v0/reports/balance-sheet/range', 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.sandbox.teal.dev/v0/reports/balance-sheet/range",
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>",
"teal-instance-id: <teal-instance-id>"
],
]);
$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.sandbox.teal.dev/v0/reports/balance-sheet/range"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("teal-instance-id", "<teal-instance-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.teal.dev/v0/reports/balance-sheet/range")
.header("teal-instance-id", "<teal-instance-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.teal.dev/v0/reports/balance-sheet/range")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["teal-instance-id"] = '<teal-instance-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"periods": [
"Q1-2020",
"Q2-2020"
],
"records": [
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
82636.12,
95582.71
],
"debit_credit": "debit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"name": "Pluto Checking 4242",
"sort_code": "1011",
"sub_type": "current_assets",
"total_amounts": [
82636.12,
95582.71
],
"type": "asset"
}
],
"debit_credit": "debit",
"name": "Current Assets",
"total_amounts": [
82636.12,
95582.71
],
"type": "asset"
}
],
"debit_credit": "debit",
"name": "Asset",
"total_amounts": [
82636.12,
95582.71
],
"type": "asset"
},
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
2713.28,
8067
],
"debit_credit": "credit",
"ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
"name": "Pluto Credit Card 2424",
"sort_code": "2010",
"sub_type": "current_liabilities",
"total_amounts": [
2713.28,
8067
],
"type": "liability"
}
],
"debit_credit": "credit",
"name": "Current Liabilities",
"total_amounts": [
2713.28,
8067
],
"type": "liability"
}
],
"debit_credit": "credit",
"name": "Liability",
"total_amounts": [
2713.28,
8067
],
"type": "liability"
},
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
47213.23,
87515.71
],
"debit_credit": "credit",
"ledger_id": "WhvrC7XAES1fDrpWWgmPtg",
"name": "Opening Balance Retained Earnings",
"sort_code": "8010",
"sub_type": "equity",
"total_amounts": [
47213.23,
87515.71
],
"type": "equity"
}
],
"debit_credit": "credit",
"name": "Equity",
"total_amounts": [
47213.23,
87515.71
],
"type": "equity"
}
],
"debit_credit": "credit",
"name": "Equity",
"total_amounts": [
47213.23,
87515.71
],
"type": "equity"
}
],
"retained_earnings_metadata": {
"calculated_retained_earnings": [
"37952.4400000000023283064365386962890625",
"48215.1500000000014551915228366851806640625"
],
"calculated_current_year_earnings": [
"9260.7900000000008731149137020111083984375",
"39300.5599999999976716935634613037109375"
]
}
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}Retrieve the balance sheets for a given range
Retrieves the balance sheets for all periods in the range. Requires a Tier 2 subscription.
curl --request GET \
--url https://api.sandbox.teal.dev/v0/reports/balance-sheet/range \
--header 'Authorization: Bearer <token>' \
--header 'teal-instance-id: <teal-instance-id>'import requests
url = "https://api.sandbox.teal.dev/v0/reports/balance-sheet/range"
headers = {
"teal-instance-id": "<teal-instance-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'teal-instance-id': '<teal-instance-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.sandbox.teal.dev/v0/reports/balance-sheet/range', 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.sandbox.teal.dev/v0/reports/balance-sheet/range",
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>",
"teal-instance-id: <teal-instance-id>"
],
]);
$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.sandbox.teal.dev/v0/reports/balance-sheet/range"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("teal-instance-id", "<teal-instance-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.teal.dev/v0/reports/balance-sheet/range")
.header("teal-instance-id", "<teal-instance-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.teal.dev/v0/reports/balance-sheet/range")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["teal-instance-id"] = '<teal-instance-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"periods": [
"Q1-2020",
"Q2-2020"
],
"records": [
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
82636.12,
95582.71
],
"debit_credit": "debit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"name": "Pluto Checking 4242",
"sort_code": "1011",
"sub_type": "current_assets",
"total_amounts": [
82636.12,
95582.71
],
"type": "asset"
}
],
"debit_credit": "debit",
"name": "Current Assets",
"total_amounts": [
82636.12,
95582.71
],
"type": "asset"
}
],
"debit_credit": "debit",
"name": "Asset",
"total_amounts": [
82636.12,
95582.71
],
"type": "asset"
},
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
2713.28,
8067
],
"debit_credit": "credit",
"ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
"name": "Pluto Credit Card 2424",
"sort_code": "2010",
"sub_type": "current_liabilities",
"total_amounts": [
2713.28,
8067
],
"type": "liability"
}
],
"debit_credit": "credit",
"name": "Current Liabilities",
"total_amounts": [
2713.28,
8067
],
"type": "liability"
}
],
"debit_credit": "credit",
"name": "Liability",
"total_amounts": [
2713.28,
8067
],
"type": "liability"
},
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
0,
0
],
"children": [
{
"amounts": [
47213.23,
87515.71
],
"debit_credit": "credit",
"ledger_id": "WhvrC7XAES1fDrpWWgmPtg",
"name": "Opening Balance Retained Earnings",
"sort_code": "8010",
"sub_type": "equity",
"total_amounts": [
47213.23,
87515.71
],
"type": "equity"
}
],
"debit_credit": "credit",
"name": "Equity",
"total_amounts": [
47213.23,
87515.71
],
"type": "equity"
}
],
"debit_credit": "credit",
"name": "Equity",
"total_amounts": [
47213.23,
87515.71
],
"type": "equity"
}
],
"retained_earnings_metadata": {
"calculated_retained_earnings": [
"37952.4400000000023283064365386962890625",
"48215.1500000000014551915228366851806640625"
],
"calculated_current_year_earnings": [
"9260.7900000000008731149137020111083984375",
"39300.5599999999976716935634613037109375"
]
}
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}{
"message": "<string>",
"data": "<unknown>",
"display_message": "<string>",
"error_code": "invalid_date"
}Authorizations
Bearer authentication header of the form Bearer , where is your auth token.
Headers
The Teal instance ID
Query Parameters
The start of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error.
The end of the time range. yyyy for yearly period, yyyy-MM for monthly period, yyyy-Q{1-4} for quarterly period, yyyy-MM-dd otherwise. The range may span at most 5 years; larger ranges are rejected with a 422 error.
The interval of the periods.
daily, monthly, quarterly, yearly Time Zone Identifier
Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Ciudad_Juarez, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Coyhaique, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Nuuk, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/NSW, Australia/North, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/Atlantic, Canada/Central, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, Chile/Continental, Chile/EasterIsland, Cuba, EET, EST, EST5EDT, Egypt, Eire, Etc/GMT, Etc/GMT+0, Etc/GMT+1, Etc/GMT+10, Etc/GMT+11, Etc/GMT+12, Etc/GMT+2, Etc/GMT+3, Etc/GMT+4, Etc/GMT+5, Etc/GMT+6, Etc/GMT+7, Etc/GMT+8, Etc/GMT+9, Etc/GMT-0, Etc/GMT-1, Etc/GMT-10, Etc/GMT-11, Etc/GMT-12, Etc/GMT-13, Etc/GMT-14, Etc/GMT-2, Etc/GMT-3, Etc/GMT-4, Etc/GMT-5, Etc/GMT-6, Etc/GMT-7, Etc/GMT-8, Etc/GMT-9, Etc/GMT0, Etc/Greenwich, Etc/UCT, Etc/UTC, Etc/Universal, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Kyiv, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, Factory, GB, GB-Eire, GMT, GMT+0, GMT-0, GMT0, Greenwich, HST, Hongkong, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, MST, MST7MDT, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, NZ, NZ-CHAT, Navajo, PRC, PST8PDT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kanton, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, ROC, ROK, Singapore, Turkey, UCT, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Samoa, UTC, Universal, W-SU, WET, Zulu, localtime 1Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription
Controls which ledgers appear in the report based on activity:
-
true: Includes all ledgers, whether they have line entries or not. -
false: Only includes ledgers that have at least one line entry. This excludes completely unused ledgers but still includes ledgers with zero balances that aren't empty. Parent ledgers with no direct line entries but active children will be returned.
Include only the changes to the balance sheet for transactions that have been closed.
Response
Successful Response
A list of periods in the range.
["Q1-2020", "Q2-2020"]
A list of Records that represents either a ledger or a groups of ledgers.
Records that are groups of ledgers are grouped by balance sheet type: asset, liability, and equity, in that order, and then by sub_type. Within each sub_type group, Ledger objects are ordered by sort_code.
Show child attributes
Show child attributes
[
{
"amounts": [0, 0],
"children": [
{
"amounts": [0, 0],
"children": [
{
"amounts": [82636.12, 95582.71],
"debit_credit": "debit",
"ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
"name": "Pluto Checking 4242",
"sort_code": "1011",
"sub_type": "current_assets",
"total_amounts": [82636.12, 95582.71],
"type": "asset"
}
],
"debit_credit": "debit",
"name": "Current Assets",
"total_amounts": [82636.12, 95582.71],
"type": "asset"
}
],
"debit_credit": "debit",
"name": "Asset",
"total_amounts": [82636.12, 95582.71],
"type": "asset"
},
{
"amounts": [0, 0],
"children": [
{
"amounts": [0, 0],
"children": [
{
"amounts": [2713.28, 8067],
"debit_credit": "credit",
"ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
"name": "Pluto Credit Card 2424",
"sort_code": "2010",
"sub_type": "current_liabilities",
"total_amounts": [2713.28, 8067],
"type": "liability"
}
],
"debit_credit": "credit",
"name": "Current Liabilities",
"total_amounts": [2713.28, 8067],
"type": "liability"
}
],
"debit_credit": "credit",
"name": "Liability",
"total_amounts": [2713.28, 8067],
"type": "liability"
},
{
"amounts": [0, 0],
"children": [
{
"amounts": [0, 0],
"children": [
{
"amounts": [47213.23, 87515.71],
"debit_credit": "credit",
"ledger_id": "WhvrC7XAES1fDrpWWgmPtg",
"name": "Opening Balance Retained Earnings",
"sort_code": "8010",
"sub_type": "equity",
"total_amounts": [47213.23, 87515.71],
"type": "equity"
}
],
"debit_credit": "credit",
"name": "Equity",
"total_amounts": [47213.23, 87515.71],
"type": "equity"
}
],
"debit_credit": "credit",
"name": "Equity",
"total_amounts": [47213.23, 87515.71],
"type": "equity"
}
]
Per-period system-computed Retained Earnings and Current Year Earnings. Useful for showing the calculated portion separately from any user-posted journal entries against the writable Retained Earnings / Current Year Earnings system ledgers.
Show child attributes
Show child attributes