Cash Flow Statements
TheCashFlowStatement
object shows operating activities, investing activities, and financing activities over a period of time (month, quarter, or year).The CashFlowStatement object
Properties
id
StringRequired
remote_id
StringOptional
The third-party API ID of the matching object.
remote_data
RemoteData[]Optional
name
StringOptional
The cash flow statement's name.
currency
EnumOptional
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
, or - in cases where there is no clear mapping - the original value passed through.company
StringOptional
The company the cash flow statement belongs to.
start_period
StringOptional
The cash flow statement's start period.
end_period
StringOptional
The cash flow statement's end period.
cash_at_beginning_of_period
NumberOptional
Cash and cash equivalents at the beginning of the cash flow statement's period.
cash_at_end_of_period
NumberOptional
Cash and cash equivalents at the beginning of the cash flow statement's period.
operating_activities
ReportItem[]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.JSON
{"remote_id": "10299","name": "Revenue","value": 1000,"sub_items": [{"remote_id": "10300","name": "Revenue - San Francisco","value": 500,"sub_items": []},{"remote_id": "10301","name": "Revenue - New York","value": 500,"sub_items": []}],"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"}
Properties
remote_id
StringOptional
The third-party API ID of the matching object.
name
StringOptional
The report item's name.
value
NumberOptional
The report item's value.
sub_items
ObjectRequired
company
StringOptional
The company the report item belongs to.
investing_activities
ReportItem[]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.JSON
{"remote_id": "10299","name": "Revenue","value": 1000,"sub_items": [{"remote_id": "10300","name": "Revenue - San Francisco","value": 500,"sub_items": []},{"remote_id": "10301","name": "Revenue - New York","value": 500,"sub_items": []}],"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"}
Properties
remote_id
StringOptional
The third-party API ID of the matching object.
name
StringOptional
The report item's name.
value
NumberOptional
The report item's value.
sub_items
ObjectRequired
company
StringOptional
The company the report item belongs to.
financing_activities
ReportItem[]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.JSON
{"remote_id": "10299","name": "Revenue","value": 1000,"sub_items": [{"remote_id": "10300","name": "Revenue - San Francisco","value": 500,"sub_items": []},{"remote_id": "10301","name": "Revenue - New York","value": 500,"sub_items": []}],"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5"}
Properties
remote_id
StringOptional
The third-party API ID of the matching object.
name
StringOptional
The report item's name.
value
NumberOptional
The report item's value.
sub_items
ObjectRequired
company
StringOptional
The company the report item belongs to.
remote_generated_at
StringOptional
The time that cash flow statement was generated by the accounting system.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
field_mappings
ObjectOptional
The CashFlowStatement object
JSON
{"id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","remote_id": "8211088","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"name": "CashFlow","currency": "USD","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","start_period": "2020-01-01T00:00:00Z","end_period": "2020-03-31T00:00:00Z","cash_at_beginning_of_period": 5000,"cash_at_end_of_period": 4063.52,"operating_activities": [{"remote_id": "10299","name": "Operating Activities","value": 1000,"sub_items": []}],"investing_activities": [{"remote_id": "10230","name": "Investing Activities","value": 1000,"sub_items": []}],"financing_activities": [{"remote_id": "10231","name": "Financing Activities","value": 1000,"sub_items": []}],"remote_generated_at": "2020-04-01T00:00:00Z","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
GET
/cash-flow-statements
Returns a list of CashFlowStatement
objects.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
company_id
StringOptional
If provided, will only return cash flow statements for this company.
created_after
StringOptional
If provided, will only return objects created after this datetime.
created_before
StringOptional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
StringOptional
If provided, will only return objects modified after this datetime.
modified_before
StringOptional
If provided, will only return objects modified before this datetime.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","remote_id": "8211088","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"name": "CashFlow","currency": "USD","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","start_period": "2020-01-01T00:00:00Z","end_period": "2020-03-31T00:00:00Z","cash_at_beginning_of_period": 5000,"cash_at_end_of_period": 4063.52,"operating_activities": [{"remote_id": "10299","name": "Operating Activities","value": 1000,"sub_items": []}],"investing_activities": [{"remote_id": "10230","name": "Investing Activities","value": 1000,"sub_items": []}],"financing_activities": [{"remote_id": "10231","name": "Financing Activities","value": 1000,"sub_items": []}],"remote_generated_at": "2020-04-01T00:00:00Z","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}
Field support by platform

QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
cash_at_beginning_of_period
Numbercash_at_end_of_period
Numbercurrency
Enumend_period
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_generated_at
Stringstart_period
String
FreshBooks

Xero
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/cash-flow-statements/{id}
Returns a CashFlowStatement
object with the given id
.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
id
StringRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b","remote_id": "8211088","remote_data": [{"path": "/actions","data": ["Varies by platform"]}],"name": "CashFlow","currency": "USD","company": "595c8f97-2ac4-45b7-b000-41bdf43240b5","start_period": "2020-01-01T00:00:00Z","end_period": "2020-03-31T00:00:00Z","cash_at_beginning_of_period": 5000,"cash_at_end_of_period": 4063.52,"operating_activities": [{"remote_id": "10299","name": "Operating Activities","value": 1000,"sub_items": []}],"investing_activities": [{"remote_id": "10230","name": "Investing Activities","value": 1000,"sub_items": []}],"financing_activities": [{"remote_id": "10231","name": "Financing Activities","value": 1000,"sub_items": []}],"remote_generated_at": "2020-04-01T00:00:00Z","remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
Field support by platform

QuickBooks Online
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
cash_at_beginning_of_period
Numbercash_at_end_of_period
Numbercurrency
Enumend_period
Stringname
Stringremote_data
RemoteData[]path
stringdata
objectremote_generated_at
Stringstart_period
String
FreshBooks

Xero
Hint: Use the /linked-accounts endpoint to pull platform support information.