COcodatio
Reports

Get enhanced profit and loss accounts

Changed on

The Enhanced Profit and Loss Accounts endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss. It also includes a balance per 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

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/reports/enhancedProfitAndLoss/accounts
  • Auth
    API key in header Authorization

Query parameters

reportDatestring required
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

  • 0167fa08722eRevision 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

  • 7ca7ffc3edf1Revision 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