Cashflow data model

Sections

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model
FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
category_idsstring[]No(reference to AccountingCategory)
contact_idstringNo(reference to AccountingContact)
namestringNoe.g. "Cash Flow Statement Q1 2020"
currencystringNoISO 4217, e.g. "USD"
cash_beginning_amountnumberNoCash at beginning of period
cash_ending_amountnumberNoCash at end of period
net_change_in_cash_amountnumberNoUsually ending - beginning
operating_sectionsAccountingCashflowSection[]No
operating_sections[].section_namestringNoe.g. "Operating Activities"
operating_sections[].total_amountnumberNoNet cash providedused by this section
operating_sections[].itemsAccountingCashflowItem[]No
operating_sections[].items[].account_idstringNoIf attributable to a specific GL account (reference to AccountingAccount)
operating_sections[].items[].namestringNoe.g. "Net Income", "Depreciation", "Equipment"
operating_sections[].items[].amountnumberNoPositive = inflow, Negative = outflow
operating_sections[].items[].transaction_idsstring[]NoOptional linkage to transactions
operating_sections[].items[].sub_itemsobjectNo
investing_sectionsAccountingCashflowSection[]No
investing_sections[].section_namestringNoe.g. "Operating Activities"
investing_sections[].total_amountnumberNoNet cash providedused by this section
investing_sections[].itemsAccountingCashflowItem[]No
investing_sections[].items[].account_idstringNoIf attributable to a specific GL account (reference to AccountingAccount)
investing_sections[].items[].namestringNoe.g. "Net Income", "Depreciation", "Equipment"
investing_sections[].items[].amountnumberNoPositive = inflow, Negative = outflow
investing_sections[].items[].transaction_idsstring[]NoOptional linkage to transactions
investing_sections[].items[].sub_itemsobjectNo
financing_sectionsAccountingCashflowSection[]No
financing_sections[].section_namestringNoe.g. "Operating Activities"
financing_sections[].total_amountnumberNoNet cash providedused by this section
financing_sections[].itemsAccountingCashflowItem[]No
financing_sections[].items[].account_idstringNoIf attributable to a specific GL account (reference to AccountingAccount)
financing_sections[].items[].namestringNoe.g. "Net Income", "Depreciation", "Equipment"
financing_sections[].items[].amountnumberNoPositive = inflow, Negative = outflow
financing_sections[].items[].transaction_idsstring[]NoOptional linkage to transactions
financing_sections[].items[].sub_itemsobjectNo

TypeScript

TypeScript
export type AccountingCashflow = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	category_ids?: string[]; // (reference to AccountingCategory)
	contact_id?: string; // (reference to AccountingContact)
	name?: string; // e.g. "Cash Flow Statement Q1 2020"
	currency?: string; // ISO 4217, e.g. "USD"
	cash_beginning_amount?: number; // Cash at beginning of period
	cash_ending_amount?: number; // Cash at end of period
	net_change_in_cash_amount?: number; // Usually ending - beginning
	operating_sections?: [];
	investing_sections?: [];
	financing_sections?: [];
	raw?: any; // Original data from the integration
}

Zod

Zod
import { z } from 'zod';

export const ZodAccountingCashflow = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	category_ids: z.array().optional().describe("(reference to AccountingCategory)"),
	contact_id: z.string().optional().describe("(reference to AccountingContact)"),
	name: z.string().optional().describe("e.g. "Cash Flow Statement Q1 2020""),
	currency: z.string().optional().describe("ISO 4217, e.g. "USD""),
	cash_beginning_amount: z.number().optional().describe("Cash at beginning of period"),
	cash_ending_amount: z.number().optional().describe("Cash at end of period"),
	net_change_in_cash_amount: z.number().optional().describe("Usually ending - beginning"),
	operating_sections: z.array().optional(),
	investing_sections: z.array().optional(),
	financing_sections: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AccountingCashflow:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""(reference to AccountingCategory)"""
	category_ids: Optional[List[List[str]]]
	"""(reference to AccountingContact)"""
	contact_id: Optional[str]
	"""e.g. "Cash Flow Statement Q1 2020""""
	name: Optional[str]
	"""ISO 4217, e.g. "USD""""
	currency: Optional[str]
	"""Cash at beginning of period"""
	cash_beginning_amount: Optional[int]
	"""Cash at end of period"""
	cash_ending_amount: Optional[int]
	"""Usually ending - beginning"""
	net_change_in_cash_amount: Optional[int]
	operating_sections: Optional[PropertyAccountingCashflowOperating_sections]
	investing_sections: Optional[PropertyAccountingCashflowInvesting_sections]
	financing_sections: Optional[PropertyAccountingCashflowFinancing_sections]
Are we missing anything? Let us know
Was this page helpful?