/cash-flow-statements/{id}

from merge import Merge
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.accounting.cash_flow_statements.retrieve(
    id="id",
)

{
  "id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
  "remote_id": "8211088",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "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": "19202938",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-09-18T00:00:00Z",
      "name": "Operating Activities",
      "value": 1000,
      "sub_items": [
        {
          "remote_id": "23042938",
          "created_at": "2021-09-15T00:00:00Z",
          "modified_at": "2021-09-18T00:00:00Z",
          "name": "Net Income",
          "value": 1097.13,
          "sub_items": []
        }
      ]
    }
  ],
  "investing_activities": [
    {
      "remote_id": "192406939",
      "created_at": "2021-11-15T00:00:00Z",
      "modified_at": "2021-11-18T00:00:00Z",
      "name": "Equipment",
      "value": 1000,
      "sub_items": [
        {
          "created_at": "2021-11-15T00:00:00Z",
          "modified_at": "2021-09-18T00:00:00Z",
          "name": "Equipment",
          "value": 1000,
          "sub_items": []
        }
      ]
    }
  ],
  "financing_activities": [
    {
      "remote_id": "192406939",
      "created_at": "2021-11-15T00:00:00Z",
      "modified_at": "2021-11-15T00:00:00Z",
      "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"
    }
  },
  "remote_data": [
    {
      "path": "/actions"
    }
  ]
}

Returns a CashFlowStatement object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

Allowed values:

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).

Response

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

namestring or null

The cash flow statement's name.

currencyenum or null

The cash flow statement's currency. The currency code in ISO 4217 format.

companystring or nullformat: "uuid"

The company the cash flow statement belongs to.

start_perioddatetime or null

The cash flow statement's start period.

end_perioddatetime or null

The cash flow statement's end period.

cash_at_beginning_of_perioddouble or null

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

cash_at_end_of_perioddouble or null

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

operating_activitieslist of objectsRead-only

investing_activitieslist of objectsRead-only

financing_activitieslist of objectsRead-only

remote_generated_atdatetime or null

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

remote_was_deletedbooleanRead-only

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_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

/cash-flow-statements/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration