See Teal in action by building a real cash flow report.
Create an Instance
coa_template_id
that you copied from the previous step.entries_start
date to 2024-01-01T00:00:00Z
. This date indicates the beginning of the business’ activity, or the migration date from another accounting system.subscription
to tier3
. More on subscription tiers can be found here
entries_start
date. Example request:
Import transactions
financial_account_type
to bank_account
.Example request:
ledger_id
.Example request:
amount
in a 2 decimal float, a datetime
of when the transaction occurred, a description
telling us about the transaction, and an id
to prevent duplicate transactions.We encourage you to prepare and submit a diverse set of banking transactions so that you can see Teal in action.Example request:
Generate a cash flow report
start_date
and an end_date
.Example request:
report_cash_flow
parameter. Here’s how to interpret the report object:
cash-flow-report
endpoint will return starting_debit_balance
and ending_debit_balance
. These are the total amounts of cash the business had across all financial account ledgers marked with the report_cash_flow
parameter, on the report’s start_date
and end_date
, respectively.starting_balances
and ending_balances
objects will break down starting_debit_balance
and ending_debit_balance
by financial account ledger.cash_flow_ledgers
object contains the ledgers that contributed to changing the total cash balance over the reporting period and by how much. It also reports on the individual line items and journal entries that contributed to the change, if you want to provide the ability to provide further detail to the user.cash_flow_ledgers
object will equal exactly the difference between the starting_debit_balance
and ending_debit_balance
amounts.