{
  "$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-business-partner-role-schema.json",
  "title": "FinanceKey.Entity.BusinessPartnerPkg.v_BusinessPartnerBusinessPartnerRole",
  "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_BusinessPartnerBusinessPartnerRole",
  "required": [
    "businessPartnerCode",
    "businessPartnerName"
  ],
  "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
    },
    "businessPartnerBusinessPartnerRoleId": {
      "type": "integer",
      "description": "This field is an integer data type that stores the ID of a specific business partner's role within the business partner relationship. It is a primary key field in the BusinessPartnerBusinessPartnerRole table.",
      "format": "int32",
      "readOnly": true
    },
    "businessPartnerRoleId": {
      "maxLength": 128,
      "type": [
        "string",
        "null"
      ],
      "description": "The role of the business partner"
    },
    "businessPartnerId": {
      "type": "integer",
      "description": "BusinessPartnerId is an int data type field in the BusinessPartnerBusinessPartnerRole table that holds the unique identifier of a business partner associated with an entity in the database. This field links all records in the BusinessPartnerBusinessRole table back to the main business partner associated with an entity.",
      "format": "int32"
    },
    "businessPartnerRoleDescription": {
      "type": [
        "string",
        "null"
      ],
      "description": "BusinessPartnerRoleDescription is a field in the BusinessPartnerBusinessPartnerRole table that stores the detailed description of the role of the business partner associated with the record. It is a nvarchar data type and accepts up to max 254 characters."
    },
    "businessPartnerCode": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string",
      "description": "The BusinessPartnerCode field in the BusinessPartnerBusinessPartnerRole table is a nvarchar data type with a maximum length of 128 characters. This field serves as a unique identification code for each business partner in the system. It is used to easily differentiate and categorize different business partners, such as customers, suppliers, or vendors. The code can consist of any combination of letters, numbers, or special characters, and it must be unique to each business partner. This field is essential for efficient and accurate record keeping and communication with business partners."
    },
    "businessPartnerName": {
      "minLength": 1,
      "type": "string",
      "description": "The BusinessPartnerName field is a nvarchar data type within the BusinessPartnerBusinessPartnerRole table. This field is used to store the name of a business partner associated with a specific role within a company. It allows for easy identification and organization of the different business partners within the company. The data type of nvarchar allows for the storage of both numeric and non-numeric characters, making it flexible for various name formats. This field is essential for keeping track of the different business partnerships and their corresponding roles within the company."
    }
  },
  "additionalProperties": false
}