{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-credit-facility-pkg-v-overdraft-exposure-schema.json",
  "title": "FinanceKey.Entity.CreditFacilityPkg.v_OverdraftExposure",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/financekey-credit-facilities-api-openapi.yml#/components/schemas/FinanceKey.Entity.CreditFacilityPkg.v_OverdraftExposure",
  "required": [
    "businessUnit",
    "total",
    "totalPosition"
  ],
  "type": "object",
  "properties": {
    "businessUnit": {
      "maxLength": 16,
      "minLength": 1,
      "type": "string",
      "description": "The BusinessUnit field in the OverdraftExposure table stores data about the business unit or division associated with each overdraft transaction. The data type is nvarchar with a maximum length of 16 characters."
    },
    "businessPartnerImage": {
      "type": [
        "string",
        "null"
      ],
      "description": "BusinessPartnerImage of data type nvarchar in OverdraftExposure table is used to store uploaded images of business partners. It is used as proof of their identity for processing overdrafts, i.e. storing copies of their id cards, passport or other official documents."
    },
    "accountReference": {
      "type": [
        "string",
        "null"
      ],
      "description": "The AccountReference field in the OverdraftExposure table is a nvarchar (string) data type primary key field which uniquely identifies a customer account record. The AccountReference field should include at least six digits and one character, for example, 1234AB."
    },
    "nameHtml": {
      "type": [
        "string",
        "null"
      ],
      "description": "NameHtml is an nvarchar field in the OverdraftExposure table that stores HTML code (data type 'nvarchar') to display the name of an entity associated with a given overdraft exposure. This field can be used to create a visual representation of the name of the entity on the UI."
    },
    "totalHtml": {
      "maxLength": 4000,
      "type": [
        "string",
        "null"
      ],
      "description": "TotalHtml is an nvarchar data field in the OverdraftExposure table with a maximum length of 4000 characters. It stores the total HTML content of the Overdraft Exposure records, such as the record's loan fund summary, the bank's summary of overdraft fees, and the overall combined overdraft exposure value."
    },
    "total": {
      "type": "number",
      "description": "Total is a field of decimal data type in the OverdraftExposure table that records the total amount of overdraft exposure associated with a given account. It is typically used to measure the credit risk associated with a particular account.",
      "format": "double"
    },
    "totalPositionHtml": {
      "maxLength": 4000,
      "type": [
        "string",
        "null"
      ],
      "description": "TotalPositionHtml is a field in the OverdraftExposure table used to store HTML markup representing the total position of an overdraft exposure in a tabular format. It has a maximum length of 4000 characters."
    },
    "totalPosition": {
      "type": "number",
      "description": "The TotalPosition field in the OverdraftExposure table stores the total amount of the current overdraft exposure, as a decimal number with up to two decimal places.",
      "format": "double"
    },
    "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
    },
    "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
    },
    "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
    }
  },
  "additionalProperties": false
}