> ## 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 Cash Flow Report > Retrieves the cash flow report for the business. Returns an object with all ledgers whose balanced changed during the period and the starting and ending balances for each cash flow ledger. ## OpenAPI ````yaml GET /v0/reports/cash-flow 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/cash-flow: get: tags: - Reports summary: Retrieve the Cash Flow Report description: >- Retrieves the cash flow report for the business. Returns an object with all ledgers whose balanced changed during the period and the starting and ending balances for each cash flow ledger. operationId: get_cash_flow_report_v0_reports_cash_flow_get parameters: - name: start_date in: query required: true schema: type: string format: date description: Only include data after the start date (inclusive). title: Start Date description: Only include data after the start date (inclusive). - name: end_date in: query required: true schema: type: string format: date description: Only include data before the end date (inclusive). title: End Date description: Only include data before the end date (inclusive). - 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: 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/CashFlowReport' '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: CashFlowReport: properties: cash_flow_ledgers: items: $ref: '#/components/schemas/CashFlowLedger' type: array title: Cash Flow Ledgers description: >- A list of Cash Flow Ledger objects indicating which ledgers were impacted by cash movements in the given period. examples: - - ledger_id: KhxYFDUi8XZBA94uoHhzs8 lines: - amount: -6682.7 cash_flow_ledger_name: Pluto Checking 4242 datetime: '2024-01-08T00:00:00Z' journal_entry_description: Hill's*Order#1460 journal_entry_id: Sd5i3iDEUPwaZks5Eqz767 line_id: MtcXSgvyVHdm44AamH3A7p name: Supplies net_cash_flow: -6682.7 total_net_cash_flow: -6682.7 - ledger_id: WhvrC7XAES1fDrpWWgmPtg lines: - amount: 13451.49 cash_flow_ledger_name: Pluto Checking 4242 datetime: '2024-01-05T00:00:00Z' journal_entry_description: Stripe Deposit - xPOLDZXC4334 journal_entry_id: 344AYLxqH6Q8W7RyHNhfjb line_id: FiiRY2pnADdxwnpajFdhSs - amount: 17801.8 cash_flow_ledger_name: Pluto Checking 4242 datetime: '2024-02-05T00:00:00Z' journal_entry_description: Stripe Deposit - aJFGJLKO2345 journal_entry_id: Msb2JMaa7MwG1XHSih35vv line_id: 921rijhvBPHDQPSmys14dc name: Sales Revenue net_cash_flow: 31253.29 total_net_cash_flow: 31253.29 ending_balances: items: $ref: '#/components/schemas/CashLedgerBalance' type: array title: Ending Balances description: >- A list of Cash Balance objects at the end of the period for ledgers reporting cash flow. examples: - - cash_balance: 38743.77 ledger_id: 7JRNsKwy2Lw66caxVU7WGC ledger_name: Pluto Checking 4242 sort_code: '1400' total_cash_balance: 38743.77 ending_cash_balance: type: number title: Ending Cash Balance description: >- The total debit balance, in decimal dollar cents, of all cash flow ledgers at the end of the period. examples: - '38743.7699999999967985786497592926025390625' starting_balances: items: $ref: '#/components/schemas/CashLedgerBalance' type: array title: Starting Balances description: >- A list of Cash Balance objects at the end of the period for ledgers reporting cash flow. examples: - - cash_balance: 14173.18 ledger_id: 7JRNsKwy2Lw66caxVU7WGC ledger_name: Pluto Checking 4242 sort_code: '1400' total_cash_balance: 14173.18 starting_cash_balance: type: number title: Starting Cash Balance description: >- The total debit balance, in decimal dollar cents, of all cash flow ledgers at the beginning of the period. examples: - '14173.1800000000002910383045673370361328125' type: object required: - cash_flow_ledgers - ending_balances - ending_cash_balance - starting_balances - starting_cash_balance title: CashFlowReport 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 CashFlowLedger: properties: children: anyOf: - items: $ref: '#/components/schemas/CashFlowLedger' type: array - type: 'null' title: Children description: If the Ledger has any children, a list of the Ledger objects. examples: - null ledger_id: type: string title: Ledger Id description: The ID of the Ledger object. examples: - 7JRNsKwy2Lw66caxVU7WGC lines: items: $ref: '#/components/schemas/CashFlowLineEntry' type: array title: Lines description: A list all Line Entries in the Ledger. examples: - - amount: 13451.49 cash_flow_ledger_name: Pluto Checking 4242 datetime: '2023-01-05T00:00:00Z' journal_entry_description: Stripe Deposit - xPOLDZXC4334 journal_entry_id: 344AYLxqH6Q8W7RyHNhfjb line_id: FiiRY2pnADdxwnpajFdhSs - amount: 17801.8 cash_flow_ledger_name: Pluto Checking 4242 datetime: '2023-02-05T00:00:00Z' journal_entry_description: Stripe Deposit - aJFGJLKO2345 journal_entry_id: Msb2JMaa7MwG1XHSih35vv line_id: 921rijhvBPHDQPSmys14dc name: type: string title: Name description: The name of the ledger. examples: - Pluto Checking 4242 net_cash_flow: type: number title: Net Cash Flow description: The sum, in decimal dollar cents, of all line entries in the Ledger. examples: - '-10837.22999999999956344254314899444580078125' parent_id: anyOf: - type: string - type: 'null' title: Parent Id description: If the Ledger is a child Ledger, the ID of the parent Ledger. examples: - null total_net_cash_flow: type: number title: Total Net Cash Flow description: >- The sum, in decimal dollar cents, of all line entries in this ledger and all its child ledgers. examples: - '-10837.22999999999956344254314899444580078125' type: object required: - ledger_id - lines - name - net_cash_flow - total_net_cash_flow title: CashFlowLedger CashLedgerBalance: properties: children: anyOf: - items: $ref: '#/components/schemas/CashLedgerBalance' type: array - type: 'null' title: Children description: If the Ledger has any children, a list of the Ledger objects. examples: - null cash_balance: type: number title: Cash Balance description: >- The debit balance, in decimal dollar cents, of all line entries in the ledger. examples: - '3822.829999999999927240423858165740966796875' ledger_id: type: string title: Ledger Id description: The ID of the Ledger object. examples: - 7JRNsKwy2Lw66caxVU7WGC ledger_name: type: string title: Ledger 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. examples: - null sort_code: type: string 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' total_cash_balance: type: number title: Total Cash Balance description: >- The debit balance, in decimal dollar cents, of all line entries in the ledger and all its child ledgers, if any. examples: - '3822.829999999999927240423858165740966796875' type: object required: - cash_balance - ledger_id - ledger_name - sort_code - total_cash_balance title: CashLedgerBalance 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 CashFlowLineEntry: properties: amount: type: number title: Amount description: The value in decimal dollar cents. examples: - '-2938.28000000000020008883439004421234130859375' datetime: type: string format: date-time title: Datetime description: When the object was created in UTC time. examples: - '2023-02-15T06:42:18Z' cash_flow_ledger_name: anyOf: - type: string - type: 'null' title: Cash Flow Ledger Name description: The name of the ledger. examples: - Pluto Checking 4242 journal_entry_description: type: string title: Journal Entry Description description: An arbitrary string on the object, useful for displaying to users. examples: - Payroll#230215 journal_entry_id: anyOf: - type: string - type: 'null' title: Journal Entry Id description: The unique ID of the object. examples: - C4ocnUQze8kDwQ3EczkZXn line_id: anyOf: - type: string - type: 'null' title: Line Id description: The unique ID of the object. examples: - XMDsKVuW4Wmi3LTW31Qw6E type: object required: - amount - datetime - cash_flow_ledger_name - journal_entry_description - journal_entry_id - line_id title: CashFlowLineEntry 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 ````