Cash Flow Statements

The CashFlowStatement object is used to represent a company's cash flow statement.

The CashFlowStatement object

Properties


idString
Optional

remote_idString
Optional
The third-party API ID of the matching object.

remote_dataRemoteData[]
Optional

nameString
Optional
The cash flow statement's name.

start_periodString
Optional
The cash flow statement's start period.

end_periodString
Optional
The cash flow statement's end period.

cash_at_beginning_of_periodNumber
Optional
Cash and cash equivalents at the beginning of the cash flow statement's period.

cash_at_end_of_periodNumber
Optional
Cash and cash equivalents at the beginning of the cash flow statement's period.

operating_activitiesReportItem[]
Optional

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.
{
  "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": []
    }
  ]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Optional

investing_activitiesReportItem[]
Optional

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.
{
  "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": []
    }
  ]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Optional

financing_activitiesReportItem[]
Optional

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.
{
  "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": []
    }
  ]
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The report item's name.

valueNumber
Optional
The report item's value.

sub_itemsObject
Optional

remote_generated_atString
Optional
The time that cash flow statement was generated by the accounting system.

The CashFlowStatement object

{
  "id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
  "remote_id": "8211088",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "name": "CashFlow",
  "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": null
    }
  ],
  "investing_activities": [
    {
      "remote_id": "10230",
      "name": "Investing Activities",
      "value": 1000,
      "sub_items": null
    }
  ],
  "financing_activities": [
    {
      "remote_id": "10231",
      "name": "Financing Activities",
      "value": 1000,
      "sub_items": null
    }
  ],
  "remote_generated_at": "2020-04-01T00:00:00Z"
}

GET

/cash-flow-statements

Returns a list of CashFlowStatement objects.


Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
      "remote_id": "8211088",
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "name": "CashFlow",
      "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": null
        }
      ],
      "investing_activities": [
        {
          "remote_id": "10230",
          "name": "Investing Activities",
          "value": 1000,
          "sub_items": null
        }
      ],
      "financing_activities": [
        {
          "remote_id": "10231",
          "name": "Financing Activities",
          "value": 1000,
          "sub_items": null
        }
      ],
      "remote_generated_at": "2020-04-01T00:00:00Z"
    }
  ]
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString
GET

/cash-flow-statements/{id}

Returns a CashFlowStatement object with the given id.


Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

Response

{
  "id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
  "remote_id": "8211088",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "name": "CashFlow",
  "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": null
    }
  ],
  "investing_activities": [
    {
      "remote_id": "10230",
      "name": "Investing Activities",
      "value": 1000,
      "sub_items": null
    }
  ],
  "financing_activities": [
    {
      "remote_id": "10231",
      "name": "Financing Activities",
      "value": 1000,
      "sub_items": null
    }
  ],
  "remote_generated_at": "2020-04-01T00:00:00Z"
}
Field support by platform

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

nameString