{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-credit-rating-pkg-v-rating-evaluation-schema.json",
  "title": "FinanceKey.Entity.CreditRatingPkg.v_RatingEvaluation",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/financekey-credit-ratings-api-openapi.yml#/components/schemas/FinanceKey.Entity.CreditRatingPkg.v_RatingEvaluation",
  "required": [
    "description",
    "entityId",
    "longTerm",
    "ratingAgencyId",
    "ratingDate",
    "ratingOutlookId",
    "shortTerm"
  ],
  "type": "object",
  "properties": {
    "createdById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that created the initial record.",
      "format": "int32",
      "readOnly": true
    },
    "createdOn": {
      "type": "string",
      "description": "The date and time the record was initially created.",
      "format": "date-time",
      "readOnly": true
    },
    "updatedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that last modified the record.",
      "format": "int32",
      "readOnly": true
    },
    "updateOn": {
      "type": "string",
      "description": "The date and time the record was last modified.",
      "format": "date-time",
      "readOnly": true
    },
    "closedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The identity of the account that deactivated and closed the record.",
      "format": "int32",
      "readOnly": true
    },
    "closedOn": {
      "type": "string",
      "description": "The date and time the record is to be considered as inactive and closed.",
      "format": "date-time",
      "readOnly": true
    },
    "active": {
      "type": "boolean",
      "description": "A flag that shows if the record is currently active. This values is calculated based on the current date and the record closed date.",
      "readOnly": true
    },
    "rowVersion": {
      "type": [
        "string",
        "null"
      ],
      "description": "A unique version stamp of the record.",
      "format": "byte",
      "readOnly": true
    },
    "sessionId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The identity of the session that last modified the record.",
      "readOnly": true
    },
    "ratingEvaluationId": {
      "type": "integer",
      "description": "The RatingEvaluationId field in the RatingEvaluation table is an integer data type that uniquely identifies a particular rating evaluation record stored in the table.",
      "format": "int32"
    },
    "entityId": {
      "maxLength": 450,
      "minLength": 1,
      "type": "string",
      "description": "EntityId is an nvarchar field of maximum length 450 characters in the RatingEvaluation table. It is used to identify ratings evaluation instances associated with entities such as customers, products, or services. It is generally a combination of entity name, id, and other information."
    },
    "parentId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ParentId field of data type int in the RatingEvaluation table is used to store the foreign key for the parent record of this record. It is used to connect ratings to a parent rating, or to link the record to any other table in the database.",
      "format": "int32"
    },
    "parentStringId": {
      "maxLength": 128,
      "type": [
        "string",
        "null"
      ],
      "description": "The ParentStringId field in the RatingEvaluation table is an nvarchar data type field with a maximum length of 128. It will store a unique identifier generated by the application that references the parent object associated with a particular rating evaluation record."
    },
    "ratingId": {
      "type": "integer",
      "description": "RatingId is an integer field in the RatingEvaluation table used to uniquely identify each individual rating entry. It is a primary key and is auto-generated upon entry.",
      "format": "int32"
    },
    "ratingAgencyId": {
      "maxLength": 32,
      "minLength": 1,
      "type": "string",
      "description": "RatingAgencyId is a nvarchar field with a maximum length of 32 that is used to store a 32-character identification code to link together related rating evaluations in the RatingEvaluation table."
    },
    "longTerm": {
      "maxLength": 16,
      "minLength": 1,
      "type": "string",
      "description": "LongTerm is an nvarchar field with a maximum length of 16 in the RatingEvaluation table. It is used to record the long-term rating or feedback given to an employee. Possible values can be 'Excellent', 'Very Good', 'Good', 'Fair', or 'Poor'."
    },
    "ratingOutlookId": {
      "maxLength": 32,
      "minLength": 1,
      "type": "string",
      "description": "The RatingOutlookId field in the RatingEvaluation table is a nvarchar field with a maximum length of 32 characters. This field contains an ID that identifies the outlook of a rating, such as strong positive, stable, or negative."
    },
    "shortTerm": {
      "maxLength": 16,
      "minLength": 1,
      "type": "string",
      "description": "ShortTerm is a field in the RatingEvaluation table in the form of an nvarchar with a maximum of 16 characters. This field is used to store a shortterm rating such as 'Good', 'Average', or 'Poor' that is used to evaluate a rating or measure performance."
    },
    "ratingDate": {
      "type": "string",
      "description": "The RatingDate field in the RatingEvaluation table contains the date when the rating evaluation was performed. It is stored as a date data type.",
      "format": "date-time"
    },
    "description": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string",
      "description": "The field called Description with data type nvarchar (variable-length character data) and a maximum length of 256 characters in the RatingEvaluation table can be used to store a brief description of the rating evaluation of the particular record."
    },
    "comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "Miscellaneous notes and information for the entry or record."
    }
  },
  "additionalProperties": false
}