{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-contact-pkg-v-hyperlink-schema.json",
  "title": "FinanceKey.Entity.ContactPkg.v_Hyperlink",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/financekey-contacts-api-openapi.yml#/components/schemas/FinanceKey.Entity.ContactPkg.v_Hyperlink",
  "required": [
    "description",
    "entityId",
    "href",
    "name",
    "url"
  ],
  "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
    },
    "hyperlinkId": {
      "type": "integer",
      "description": "HyperlinkId is an integer data type used to identify each row in the Hyperlink table. Each row contains a unique integer value generated upon creation and can be used to quickly identify a specific record in the table.",
      "format": "int32",
      "readOnly": true
    },
    "name": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string",
      "description": "Name of the URL. This text will be shown in the href link."
    },
    "url": {
      "minLength": 1,
      "type": "string",
      "description": "The web address"
    },
    "description": {
      "maxLength": 450,
      "minLength": 1,
      "type": "string",
      "description": "Description and purpose of the hyperlink"
    },
    "href": {
      "minLength": 1,
      "type": "string",
      "description": "The Href field of data type nvarchar in the Hyperlink table stores the Uniform Resource Locator (URL) of the page being hyperlinked. It is typically used to provide hyperlinks to other webpages, allowing the user to access them quickly with the click of a button."
    },
    "comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "Miscellaneous notes and information for the entry or record."
    },
    "parentId": {
      "type": "integer",
      "description": "The ParentId field in the Hyperlink table is an integral field which identifies the parent relationship in the linked data registry. The ParentId is a referenced key in this registry, linking parent and child records together. Thus, this field is essential for accessing and comprehension of the relationship between records.",
      "format": "int32"
    },
    "entityId": {
      "maxLength": 450,
      "minLength": 1,
      "type": "string",
      "description": "The EntityId field of data type nvarchar with a maximum length of 450 as stored in the Hyperlink table is used to store a unique identifier for each hyperlink record. This identifier will be used to retrieve the entity record when needed and will also be used to link multiple records related to the same entity."
    },
    "parentBusinessPartnerId": {
      "type": "integer",
      "description": "The ParentBusinessPartnerId field in the Hyperlink table is an integer data type and is used to link the Hyperlink records to a parent record in the same table, to provide a chain of related records. The value stored in this field is the primary key of the parent record, and is used to link the two together.",
      "format": "int32"
    }
  },
  "additionalProperties": false
}