Accounting: Balance sheet

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountingBalanceSheet",
  "title": "Accounting: Balance sheet",
  "description": "## Overview\n\nThe balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes.\n\n> **Balance sheet or profit and loss report?**\n>\n> A profit and loss report summarises the total revenue, expenses, and profit or loss during a specified time period. A balance sheet report shows the financial position of a company at a specific moment in time.\n\n**Structure of this report**\nThis report will reflect the structure and line descriptions that the business has set in their own accounting software.\n\n**History**\nBy default, Codat pulls (up to) 24 months of balance sheets for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `balanceSheet` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/update-sync-settings).\n\n**Want to pull this in a standardised structure?**\nOur [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "currency": {
      "$ref": "#/components/schemas/SourceAccount/properties/currency",
      "description": "Currency of the balance sheet."
    },
    "reports": {
      "type": "array",
      "description": "An array of balance sheet reports.",
      "items": {
        "$ref": "#/components/schemas/AccountingBalanceSheet/definitions/balanceSheet"
      }
    },
    "mostRecentAvailableMonth": {
      "$ref": "#/components/schemas/DateTime",
      "nullable": true,
      "description": "Most recent available monthly report data."
    },
    "earliestAvailableMonth": {
      "$ref": "#/components/schemas/DateTime",
      "nullable": true,
      "description": "Earliest available monthly report data."
    }
  },
  "required": [
    "reports"
  ],
  "definitions": {
    "balanceSheet": {
      "type": "object",
      "properties": {
        "date": {
          "$ref": "#/components/schemas/DateTime",
          "description": "Point in time when a snapshot of a company's financial position is taken."
        },
        "assets": {
          "$ref": "#/components/schemas/ReportLine",
          "description": "ReportLines for assets. For example, fixed and current assets."
        },
        "liabilities": {
          "$ref": "#/components/schemas/ReportLine",
          "description": "ReportLines for liabilities. For example, current liabilities."
        },
        "netAssets": {
          "type": "number",
          "format": "decimal",
          "description": "Value of net assets for a company in their base currency."
        },
        "equity": {
          "$ref": "#/components/schemas/ReportLine",
          "description": "ReportLines for equities. For example, retained and current year earnings. See below."
        }
      },
      "required": [
        "netAssets"
      ]
    }
  }
}