Cash Flow Statements
The
CashFlowStatement
object shows operating activities, investing activities, and financing activities over a period of time (month, quarter, or year).Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
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
. In cases where there is no clear mapping, the original value passed through will be returned.company
UUIDOptional
The company the cash flow statement belongs to.
start_period
DateTime (ISO 8601)Optional
The cash flow statement's start period.
end_period
DateTime (ISO 8601)Optional
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.Properties
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
name
StringOptional
The report item's name.
value
NumberOptional
The report item's value.
sub_items
ObjectRequired
company
UUIDOptional
The company the report item belongs to.
remote_was_deleted
BooleanRequired
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_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.Properties
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
name
StringOptional
The report item's name.
value
NumberOptional
The report item's value.
sub_items
ObjectRequired
company
UUIDOptional
The company the report item belongs to.
remote_was_deleted
BooleanRequired
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_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.Properties
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
name
StringOptional
The report item's name.
value
NumberOptional
The report item's value.
sub_items
ObjectRequired
company
UUIDOptional
The company the report item belongs to.
remote_was_deleted
BooleanRequired
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_at
DateTime (ISO 8601)Optional
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 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_mappings
ObjectOptional
remote_data
RemoteData[]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_id
StringOptional
If provided, will only return cash flow statements for this company.
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
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_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
BooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
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_activities
ReportItem[]name
stringvalue
numbersub_items
objectcash_at_beginning_of_period
Numbercash_at_end_of_period
Numbercurrency
Enumend_period
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_period
DateTime (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_activities
ReportItem[]remote_id
stringname
stringvalue
numbersub_items
objectcash_at_beginning_of_period
Numbercash_at_end_of_period
Numbercurrency
Enumend_period
DateTime (ISO 8601)name
Stringremote_data
RemoteData[]path
stringdata
stringremote_generated_at
DateTime (ISO 8601)start_period
DateTime (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
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
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_activities
ReportItem[]name
stringvalue
numbersub_items
objectcash_at_beginning_of_period
Numbercash_at_end_of_period
Numbercurrency
Enumend_period
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringstart_period
DateTime (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_activities
ReportItem[]remote_id
stringname
stringvalue
numbersub_items
objectcash_at_beginning_of_period
Numbercash_at_end_of_period
Numbercurrency
Enumend_period
DateTime (ISO 8601)name
Stringremote_data
RemoteData[]path
stringdata
stringremote_generated_at
DateTime (ISO 8601)start_period
DateTime (ISO 8601)Xero
Not seeing an integration that you're looking for? Submit a request for it.