Cash Flow Statements
The
CashFlowStatement object shows operating activities, investing activities, and financing activities over a period of time (month, quarter, or year).Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
nameStringOptional
The cash flow statement's name.
currencyEnumOptional
The cash flow statement's currency. Possible values include:
XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.companyUUIDOptional
The company the cash flow statement belongs to.
start_periodDateTime (ISO 8601)Optional
The cash flow statement's start period.
end_periodDateTime (ISO 8601)Optional
The cash flow statement's end period.
cash_at_beginning_of_periodNumberOptional
Cash and cash equivalents at the beginning of the cash flow statement's period.
cash_at_end_of_periodNumberOptional
Cash and cash equivalents at the beginning of the cash flow statement's period.
operating_activitiesReportItem[]Required
The ReportItem object
The
ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.Properties
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
nameStringOptional
The report item's name.
valueNumberOptional
The report item's value.
sub_itemsObjectRequired
companyUUIDOptional
The company the report item belongs to.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
investing_activitiesReportItem[]Required
The ReportItem object
The
ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.Properties
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
nameStringOptional
The report item's name.
valueNumberOptional
The report item's value.
sub_itemsObjectRequired
companyUUIDOptional
The company the report item belongs to.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
financing_activitiesReportItem[]Required
The ReportItem object
The
ReportItem object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.Properties
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
nameStringOptional
The report item's name.
valueNumberOptional
The report item's value.
sub_itemsObjectRequired
companyUUIDOptional
The company the report item belongs to.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
remote_generated_atDateTime (ISO 8601)Optional
The time that cash flow statement was generated by the accounting system.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/cash-flow-statements
https://api.merge.dev/api/accounting/v1/cash-flow-statements
US
EU
APAC
Returns a list of CashFlowStatement objects.
Query & Path Parameters
company_idStringOptional
If provided, will only return cash flow statements for this company.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
operating_activitiesReportItem[]namestringvaluenumbersub_itemsobjectcash_at_beginning_of_periodNumbercash_at_end_of_periodNumbercurrencyEnumend_periodDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringstart_periodDateTime (ISO 8601)
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
operating_activitiesReportItem[]remote_idstringnamestringvaluenumbersub_itemsobjectcash_at_beginning_of_periodNumbercash_at_end_of_periodNumbercurrencyEnumend_periodDateTime (ISO 8601)nameStringremote_dataRemoteData[]pathstringdatastringremote_generated_atDateTime (ISO 8601)start_periodDateTime (ISO 8601)
Xero
Not seeing an integration that you're looking for? Submit a request for it.
GET
/cash-flow-statements/{id}
https://api.merge.dev/api/accounting/v1/cash-flow-statements/{id}
US
EU
APAC
Returns a CashFlowStatement object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
FreshBooks
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
operating_activitiesReportItem[]namestringvaluenumbersub_itemsobjectcash_at_beginning_of_periodNumbercash_at_end_of_periodNumbercurrencyEnumend_periodDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringstart_periodDateTime (ISO 8601)QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
operating_activitiesReportItem[]remote_idstringnamestringvaluenumbersub_itemsobjectcash_at_beginning_of_periodNumbercash_at_end_of_periodNumbercurrencyEnumend_periodDateTime (ISO 8601)nameStringremote_dataRemoteData[]pathstringdatastringremote_generated_atDateTime (ISO 8601)start_periodDateTime (ISO 8601)Xero
Not seeing an integration that you're looking for? Submit a request for it.