> ## Documentation Index > Fetch the complete documentation index at: https://docs.teal.dev/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve the balance sheets for a given range > Retrieves the balance sheets for all periods in the range. Requires a Tier 2 subscription. ## OpenAPI ````yaml GET /v0/reports/balance-sheet/range openapi: 3.1.0 info: title: Teal API version: '0.1' servers: - url: https://api.sandbox.teal.dev description: Sandbox - url: https://api.teal.dev description: Production security: [] paths: /v0/reports/balance-sheet/range: get: tags: - Reports summary: Retrieve the balance sheets for a given range description: |- Retrieves the balance sheets for all periods in the range. Requires a Tier 2 subscription. operationId: get_balance_sheet_range_v0_reports_balance_sheet_range_get parameters: - name: range_start in: query required: true schema: type: string description: >- 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. title: Range Start description: >- 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. - name: range_end in: query required: true schema: type: string description: >- 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. title: Range End description: >- 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. - name: period in: query required: true schema: $ref: '#/components/schemas/Period' description: The interval of the periods. description: The interval of the periods. - name: time_zone in: query required: false schema: type: string enum: - 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 minLength: 1 title: Time Zone description: Time Zone Identifier default: UTC description: Time Zone Identifier - name: tag_ids in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: >- Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription teal_explode: false title: Tag Ids description: >- Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription - name: include_empty in: query required: false schema: type: boolean description: >- 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. default: true title: Include Empty description: >- 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. - name: include_only_closed in: query required: false schema: type: boolean description: >- Include only the changes to the balance sheet for transactions that have been closed. default: false title: Include Only Closed description: >- Include only the changes to the balance sheet for transactions that have been closed. - name: teal-instance-id in: header required: true schema: type: string description: The Teal instance ID title: Teal-Instance-Id description: The Teal instance ID responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BalanceSheetPeriods' '403': content: application/json: schema: $ref: '#/components/schemas/TealErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/TealErrorResponse' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/TealErrorResponse' description: Unprocessable Content '503': content: application/json: schema: $ref: '#/components/schemas/TealErrorResponse' description: Service Unavailable security: - OAuth2PasswordBearer: [] components: schemas: Period: type: string enum: - daily - monthly - quarterly - yearly title: Period BalanceSheetPeriods: properties: periods: items: type: string type: array title: Periods description: A list of periods in the range. examples: - - Q1-2020 - Q2-2020 records: items: $ref: '#/components/schemas/ReportPeriodsRecord' type: array title: Records description: >- 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`. examples: - - 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 type: object required: - periods - records title: BalanceSheetPeriods TealErrorResponse: properties: message: anyOf: - type: string - type: 'null' title: Message description: A description of the error for API developers. data: title: Data description: Data associated with the error. display_message: anyOf: - type: string - type: 'null' title: Display Message description: A description of the error for end users. error_code: anyOf: - $ref: '#/components/schemas/TealErrorCode' - type: 'null' description: Error code associated with the error. type: object required: - message title: TealErrorResponse ReportPeriodsRecord: properties: amounts: items: type: number type: array title: Amounts description: The sum, in decimal dollar cents, of all line entries in the ledger. examples: - - '10237.22999999999956344254314899444580078125' - '12736.2099999999991268850862979888916015625' debit_credit: $ref: '#/components/schemas/DebitCredit' description: Indicates if the ledger is a credit or debit ledger. examples: - debit ledger_id: anyOf: - type: string - type: 'null' title: Ledger Id description: The ID of the Ledger object. examples: - 7JRNsKwy2Lw66caxVU7WGC name: type: string title: Name description: The name of the ledger. examples: - Pluto Checking 4242 parent_id: anyOf: - type: string - type: 'null' title: Parent Id description: If the ledger is a child Ledger, the ID of the parent ledger object. examples: - null sort_code: anyOf: - type: string - type: 'null' title: Sort Code description: >- Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`. examples: - '1400' sub_type: anyOf: - $ref: '#/components/schemas/LedgerSubType' - type: 'null' description: >- Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`. examples: - current_assets total_amounts: items: type: number type: array title: Total Amounts description: >- The sum, in decimal dollar cents, of the ledger `amount` and the `amount` of all child ledgers, if any. examples: - - '10237.22999999999956344254314899444580078125' - '12736.2099999999991268850862979888916015625' type: anyOf: - $ref: '#/components/schemas/LedgerType' - type: 'null' description: >- Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: `asset`, `liability` and `equity` ledgers are displayed on the balance sheet; `revenue` and `expenses` are displayed on the income statement. examples: - asset children: anyOf: - items: $ref: '#/components/schemas/ReportPeriodsRecord' type: array - type: 'null' title: Children description: If the Ledger has any children, a list of the Ledger objects. examples: - null type: object required: - amounts - debit_credit - name - total_amounts title: ReportPeriodsRecord TealErrorCode: type: string enum: - invalid_date - invalid_ledger - missing_parameters - duplicate_name - duplicate_sort_code - invalid_ledger_type - invalid_ledger_report_cash_flow - deleting_required_ledger - repeated_tag_group - deleting_transaction_line - modifying_read_only_ledger - debits_credits_not_equal - modifying_datetime_opening_balance - modifying_accrual_journal_entry - modifying_payment_application_journal_entry - reconciliation_in_progress - reconciled_balance_does_not_match - journal_entry_outside_reconciliation_period - entries_start_date_after_transactions - entries_start_date_after_reconciliations - entries_start_date_after_journal_entries title: TealErrorCode DebitCredit: type: string enum: - debit - credit title: DebitCredit LedgerSubType: type: string enum: - current_assets - non-current_assets - transfers_between_accounts - uncategorized_assets - current_liabilities - non-current_liabilities - equity - operating_revenues - other_income - cost_of_goods_sold - operating_expenses - other_expenses - retained_earnings title: LedgerSubType LedgerType: type: string enum: - asset - liability - equity - revenue - expense title: LedgerType securitySchemes: OAuth2PasswordBearer: type: oauth2 description: >- Bearer authentication header of the form Bearer , where is your auth token. flows: password: scopes: {} tokenUrl: https://developer.teal.dev ````