Codat · Schema

Closed Books Indicator

Unified_API

Properties

Name Type Description
booksClosedDate object The date time in UTC the books closed.
accountingScore object A score based on data completeness, accuracy, consistency, and presentation of data and the reasons for the score.
View JSON Schema on GitHub

JSON Schema

codat-financialsummary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FinancialSummary",
  "title": "Closed Books Indicator",
  "type": "object",
  "properties": {
    "booksClosedDate": {
      "type": "object",
      "description": "The date time in UTC the books closed.",
      "properties": {
        "date": {
          "type": "string",
          "format": "date-time",
          "description": "The date time in UTC the books closed.",
          "example": "2025-05-31T00:00:00Z"
        },
        "reason": {
          "type": "array",
          "description": "List of reasons explaining the books closed date.",
          "items": {
            "type": "string"
          },
          "example": [
            "One or more accounts show a deviation from expected movements for March 2025",
            "One of the marketing accounts haven't been booked for February 2025",
            "One of the inventory accounts haven't been booked for March 2025"
          ]
        }
      }
    },
    "accountingScore": {
      "type": "object",
      "description": "A score based on data completeness, accuracy, consistency, and presentation of data and the reasons for the score.",
      "properties": {
        "score": {
          "type": "number",
          "format": "decimal",
          "description": "The accounting score value.",
          "example": 90
        },
        "reason": {
          "type": "array",
          "description": "List of reasons explaining the accounting score.",
          "items": {
            "type": "string"
          },
          "example": [
            "Balance sheet is unbalanced.",
            "Negative Tangible Assets on Balance Sheet",
            "Negative Accounts Receivable on Balance Sheet"
          ]
        }
      }
    }
  }
}