COcodatio
Financial statements

Get categorized profit and loss statement

Changed on

The Get categorized profit and loss statement endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date.

Codat suggests a category for each account automatically, but you can change it to a more suitable one.

get/companies/{companyId}/reports/enhancedProfitAndLoss/accounts

Request

Query parameters

reportDatestring
Example:29-09-2020

The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.

numberOfPeriodsinteger

The number of periods to return. If not provided, 12 periods will be used as the default value.

Response

OK

reportInfoEnhancedReportInfo (unresolved $ref)

Example response

{
  "reportInfo": {
    "reportName": "EnhancedProfitAndLossAccounts",
    "companyName": "ABC LTD",
    "generatedDate": "2022-01-01"
  },
  "reportItems": [
    {
      "date": "2022-01-01",
      "balance": 70,
      "accountName": "Sales UK",
      "accountId": "13931cbf-ea06-4d6e-9538-a8457fa66011",
      "accountCategory": {
        "status": "Suggested",
        "levels": [
          {
            "levelName": "Income",
            "confidence": 0.95
          },
          {
            "levelName": "Revenue",
            "confidence": 0.9
          }
        ]
      }
    },
    {
      "date": "2022-01-01",
      "balance": 30,
      "accountName": "Sales US",
      "accountId": "13931cbf-ea06-4d6e-9538-a8457fa66011",
      "accountCategory": {
        "lastUpdated": "2022-01-02",
        "status": "Suggested",
        "levels": [
          {
            "levelName": "Income",
            "confidence": 0.95
          },
          {
            "levelName": "Revenue",
            "confidence": 0.9
          }
        ]
      }
    },
    {
      "date": "2022-01-01",
      "balance": 70,
      "accountName": "Amazon",
      "accountId": "13931cbf-ea06-4d6e-9538-a8457fa66011",
      "accountCategory": {
        "lastUpdated": "2022-01-02",
        "status": "Suggested",
        "levels": [
          {
            "levelName": "Income",
            "confidence": 0.95
          },
          {
            "levelName": "Revenue",
            "confidence": 0.95
          },
          {
            "levelName": "Online",
            "confidence": 0.8
          }
        ]
      }
    }
  ]
}

Changes

  • 2244d9343d0aRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 799afe3f1a9fRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status