{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-business-partner-pkg-v-business-partner-exposure-schema.json",
  "title": "FinanceKey.Entity.BusinessPartnerPkg.v_BusinessPartnerExposure",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/financekey-business-partners-api-openapi.yml#/components/schemas/FinanceKey.Entity.BusinessPartnerPkg.v_BusinessPartnerExposure",
  "required": [
    "code",
    "name",
    "nameHtml"
  ],
  "type": "object",
  "properties": {
    "businessUnit": {
      "maxLength": 128,
      "type": [
        "string",
        "null"
      ],
      "description": "BusinessUnit is an nvarchar field in the BusinessPartnerExposure table with a maximum length of 16 characters. It contains the business unit value associated with a partner, such as retail, finance, manufacturing, etc."
    },
    "businessPartnerImage": {
      "type": [
        "string",
        "null"
      ],
      "description": "BusinessPartnerImage is a primary key field of data type nvarchar in the BusinessPartnerExposure table. It stores the path or URL of an image related to the business partner, such as a logo or profile picture."
    },
    "name": {
      "minLength": 1,
      "type": "string",
      "description": "The Name of data type nvarchar field in the BusinessPartnerExposure table stores the unique identifier assigned to each business partner in the system. This field value is used to provide visibility into the company's exposure to each business partner. The data type of this field is nvarchar, which allows the storage of up to 4000 characters."
    },
    "code": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string",
      "description": "BusinessPartnerExposure.Code is an nvarchar field with maximum length of 128 characters that identify a particular code assigned to each business partner within the system. This code is used to differentiate a particular business partner from other business partners as well as track total exposure, the customer relationship status and other external metrics."
    },
    "nameHtml": {
      "minLength": 1,
      "type": "string",
      "description": "NameHtml is a field of data type nvarchar that stores text information related to the exposed name of a business partner in HTML format in the BusinessPartnerExposure table. This allows users to display the name of the business partner in a format that matches the design/style of a website."
    },
    "total": {
      "type": [
        "number",
        "null"
      ],
      "description": "The Total field in the BusinessPartnerExposure table stores the total monetary value of the exposure a business partner holds with the company. The Total field is of data type decimal and can store up to 8 decimal places.",
      "format": "double"
    },
    "totalHtml": {
      "maxLength": 4000,
      "type": [
        "string",
        "null"
      ],
      "description": "The TotalHtml field of the BusinessPartnerExposure table contains an nvarchar data type with a maximum length of 4000 characters. This field stores the HTML text that gives a detailed description of the operations and exposures of a business partner."
    },
    "totalPosition": {
      "type": [
        "number",
        "null"
      ],
      "description": "The TotalPosition field of data type decimal in the BusinessPartnerExposure table stores the total exposure or risk amount of the business partner in a particular transaction.",
      "format": "double"
    },
    "totalPositionHtml": {
      "maxLength": 4000,
      "type": [
        "string",
        "null"
      ],
      "description": "TotalPositionHtml is the field in the BusinessPartnerExposure table that stores the Position HTML of the total exposure of a business partner, with a maximum allowed length of 4000 characters."
    },
    "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
}