Get profit and loss

{
  "type": "object",
  "description": "> **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles).\n\n> View the coverage for profit and loss in the <a className=\"external\" href=\"https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=profitAndLoss\" target=\"_blank\">Data coverage explorer</a>.\n\n## Overview\n\nThe purpose of a profit and loss report is to present the financial performance of a company over a specified time period.\n\nA profit and loss report shows a company's total income and expenses for a specified period of time and whether a profit or loss has been made.\n\n> **Profit and loss or balance sheet?**  \n> Profit and loss reports summarise the total revenue, expenses, and profit or loss over a specified time period. A balance sheet report presents all assets, liability, and equity for a given date.\n\n\n**Structure of this report**  \nThis report will reflect the structure and line descriptions that the business has set in their own accounting platform.\n\n**History**  \nBy default, Codat pulls (up to) 24 months of profit and loss history for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `profitAndLoss` on the [data type settings endpoint](https://docs.codat.io/codat-api#/operations/post-profile-syncSettings).\n\n**Want to pull this in a standardised structure?**  \nOur [Enhanced Financials](https://docs.codat.io/assess/reports/enhanced-financials/financials) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers.",
  "required": [
    "currency",
    "reportBasis",
    "reports"
  ],
  "properties": {
    "currency": {
      "type": "string",
      "description": "Base currency of the company in which the profit and loss report is presented."
    },
    "earliestAvailableMonth": {
      "type": "string",
      "description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
    },
    "mostRecentAvailableMonth": {
      "type": "string",
      "description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
    },
    "reportBasis": {
      "type": "string",
      "description": "The basis of a report.",
      "enum": [
        "Unknown",
        "Accrual",
        "Cash"
      ]
    },
    "reports": {
      "type": "array",
      "description": "An array of profit and loss reports.",
      "items": {
        "type": "object",
        "required": [
          "grossProfit",
          "netOperatingProfit",
          "netOtherIncome",
          "netProfit"
        ],
        "properties": {
          "costOfSales": {
            "type": "object",
            "required": [
              "value"
            ],
            "properties": {
              "accountId": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Identifier for the account, unique for the company in the accounting platform."
              },
              "items": {
                "type": [
                  "array",
                  "null"
                ],
                "description": "An array of ReportLine items.",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Name of the report line item."
              },
              "value": {
                "type": "number",
                "description": "Numerical value of the line item."
              }
            }
          },
          "expenses": {
            "type": "object",
            "additionalProperties": true
          },
          "fromDate": {
            "type": "string",
            "description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
          },
          "grossProfit": {
            "type": "number",
            "description": "Gross profit of the company in the given date range."
          },
          "income": {
            "type": "object",
            "additionalProperties": true
          },
          "netOperatingProfit": {
            "type": "number",
            "description": "Net operating profit of the company in the given date range."
          },
          "netOtherIncome": {
            "type": "number",
            "description": "Net other income of the company in the given date range."
          },
          "netProfit": {
            "type": "number",
            "description": "Net profit of the company in the given date range."
          },
          "otherExpenses": {
            "type": "object",
            "additionalProperties": true
          },
          "otherIncome": {
            "type": "object",
            "additionalProperties": true
          },
          "toDate": {
            "type": "string",
            "description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
          }
        },
        "additionalProperties": false
      }
    }
  }
}