Merge · Schema

ReportItem

# The ReportItem Object ### Description The `ReportItem` object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report. ### Usage Example Fetch from the `GET BalanceSheet` endpoint and view the balance sheet's report items.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name Type Description
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 report item's name.
value numbernull The report item's value.
sub_items object
company stringnull The company the report item belongs to.
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
View JSON Schema on GitHub

JSON Schema

merge-reportitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ReportItem",
  "title": "ReportItem",
  "type": "object",
  "properties": {
    "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 report item's name."
    },
    "value": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "description": "The report item's value."
    },
    "sub_items": {
      "type": "object",
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "company": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The company the report item belongs to."
    },
    "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/)."
    }
  },
  "description": "# The ReportItem Object\n### Description\nThe `ReportItem` object is used to represent a report item for a Balance Sheet, Cash Flow Statement or Profit and Loss Report.\n\n### Usage Example\nFetch from the `GET BalanceSheet` endpoint and view the balance sheet's report items."
}