Merge · Schema

CashFlowStatement

# The CashFlowStatement Object ### Description The `CashFlowStatement` object shows operating activities, investing activities, and financing activities over a period of time (month, quarter, or year). ### Usage Example Fetch from the `LIST CashFlowStatements` endpoint and view a company's cash flow statements.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
name	stringnull	The cash flow statement's name.
currency	object	The cash flow statement's currency. The currency code in ISO 4217 format.
company	stringnull	The company the cash flow statement belongs to.
start_period	stringnull	The cash flow statement's start period.
end_period	stringnull	The cash flow statement's end period.
cash_at_beginning_of_period	numbernull	Cash and cash equivalents at the beginning of the cash flow statement's period.
cash_at_end_of_period	numbernull	Cash and cash equivalents at the beginning of the cash flow statement's period.
operating_activities	array
investing_activities	array
financing_activities	array
remote_generated_at	stringnull	The time that cash flow statement was generated by the accounting system.
remote_was_deleted	boolean	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 cove
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CashFlowStatement",
  "title": "CashFlowStatement",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The cash flow statement's name."
    },
    "currency": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransactionCurrencyEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The cash flow statement's currency. The currency code in ISO 4217 format."
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the cash flow statement belongs to."
    },
    "start_period": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The cash flow statement's start period."
    },
    "end_period": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The cash flow statement's end period."
    },
    "cash_at_beginning_of_period": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "Cash and cash equivalents at the beginning of the cash flow statement's period."
    },
    "cash_at_end_of_period": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "Cash and cash equivalents at the beginning of the cash flow statement's period."
    },
    "operating_activities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ReportItem"
      }
    },
    "investing_activities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ReportItem"
      }
    },
    "financing_activities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ReportItem"
      }
    },
    "remote_generated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "The time that cash flow statement was generated by the accounting system."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "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](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CashFlowStatementFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The CashFlowStatement Object\n### Description\nThe `CashFlowStatement` object shows operating activities, investing activities, and financing activities over a period of time (month, quarter, or year).\n\n### Usage Example\nFetch from the `LIST CashFlowStatements` endpoint and view a company's cash flow statements."
}