FinanceKey.Entity.PaylinkPkg.v_Paylink

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/financekey/main/json-schema/financekey-finance-key-entity-paylink-pkg-v-paylink-schema.json",
  "title": "FinanceKey.Entity.PaylinkPkg.v_Paylink",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/financekey-api-openapi.yml#/components/schemas/FinanceKey.Entity.PaylinkPkg.v_Paylink",
  "required": [
    "actionRequired",
    "amount",
    "fileName",
    "paylinkCategoryBadge",
    "paylinkCategoryId",
    "paymentValueDate",
    "reportingAmount"
  ],
  "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
    },
    "paylinkId": {
      "type": "integer",
      "description": "The PaylinkId field in the Paylink table is an identity field of data type int, which serves as a unique identifier for each record in the table. This field is automatically generated and incremented by the database system, ensuring that each Paylink record has a distinct and permanent identification number. The PaylinkId is essential for tracking and managing individual records within the Paylink table and is frequently used as a primary key for data retrieval and manipulation. As an identity field, the PaylinkId provides a reliable and efficient way to uniquely identify and reference specific data in the Paylink table.",
      "format": "int32"
    },
    "paylinkTemplateId": {
      "type": "integer",
      "description": "The template that should be used to process the file.",
      "format": "int32"
    },
    "documentMessageId": {
      "maxLength": 256,
      "type": [
        "string",
        "null"
      ],
      "description": "The document message as contained inside the paylink file."
    },
    "templateDescription": {
      "maxLength": 256,
      "type": [
        "string",
        "null"
      ],
      "description": "The TemplateDescription field in the Paylink table is of data type nvarchar, with a maximum length of 256 characters. This field is used to describe the nature or purpose of the template associated with a specific paylink. It may include details such as the name of the template, its intended use, and any relevant keywords or tags. This information can be helpful in organizing and identifying templates in the Paylink table, making it easier to locate and select the appropriate template for a given transaction."
    },
    "amount": {
      "type": "number",
      "description": "The field 'Amount' in the 'Paylink' table is a decimal data type that represents a monetary value. This field allows for precise and accurate recording of financial transactions within the table. It is typically used to store the amount of money being sent or received through the paylink platform. The data type decimal ensures that the value is represented with the appropriate number of decimal places, making it ideal for recording currency values. With this field, users can easily track the amount of money being transferred and perform calculations on the data. The decimal data type adds a level of exactness and reliability to financial records in the Paylink table.",
      "format": "double"
    },
    "reportingAmount": {
      "type": "number",
      "description": "The ReportingAmount field in the Paylink table is a decimal data type that stores numerical values with decimal points, allowing for accurate and precise reporting of financial transactions. This field plays a vital role in providing detailed and accurate financial records for businesses and organizations that utilize the Paylink system. It may also be used to track and report fees, taxes, or other monetary values associated with transactions. The ReportingAmount field ensures the reliability and integrity of financial data in the Paylink system, making it an essential component for efficient and effective financial reporting.",
      "format": "double"
    },
    "currencyId": {
      "maxLength": 128,
      "type": [
        "string",
        "null"
      ],
      "description": "The CurrencyId field in the Paylink table is a nvarchar data type with a maximum length of 128. This field stores a unique identifier for the currency used in a payment transaction through the Paylink platform. The CurrencyId serves as a reference for the specific currency and allows for accurate tracking and organization of payment data. This field is important for ensuring proper currency conversion and accurate financial reporting for both users and administrators of the Paylink system."
    },
    "paylinkStateId": {
      "maxLength": 32,
      "type": [
        "string",
        "null"
      ],
      "description": "The state showing the current stage of processing for the file."
    },
    "comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "Miscellaneous notes and information for the entry or record."
    },
    "transactionCount": {
      "type": "integer",
      "description": "TransactionCount is a field in the Paylink table that stores the number of transactions associated with a particular payment link. It is of data type int, meaning it can hold whole numeric values. This field is beneficial for keeping track of the number of times a payment link has been used and can be used to analyze the popularity and effectiveness of different links. It can also help in monitoring and managing the transaction volume of the Paylink table. The TransactionCount field is an essential component for tracking the success of payment links and providing valuable insights for optimization and decision-making processes.",
      "format": "int32"
    },
    "bankState": {
      "maxLength": 32,
      "type": [
        "string",
        "null"
      ],
      "description": "The BankState field in the Paylink table is a nvarchar data type with a maximum length of 32 characters. This field is specifically used to store the state in which a bank is located. It is designed to provide information regarding the geographic location of a bank, which can be useful for financial transactions and record keeping purposes. The data in this field will only accept text input and must not exceed the specified maximum length. Additionally, it is a required field, meaning that every record in the Paylink table must have a value in this field."
    },
    "paylinkStateBadge": {
      "maxLength": 4000,
      "type": [
        "string",
        "null"
      ],
      "description": "The PaylinkStateBadge field in the Paylink table is an nvarchar data type with a maximum length of 4000 characters. This field stores the state badge of a Paylink, which is a unique identifier used to represent a specific state. Each state badge corresponds to a particular set of rules and regulations that govern the payment process within Paylink. This field is crucial for tracking and managing the payment status of Paylinks, ensuring maximum efficiency and accuracy in the payment process."
    },
    "approvalRequirementId": {
      "maxLength": 450,
      "type": [
        "string",
        "null"
      ],
      "description": "The ApprovalRequirementId field in the Paylink table is a nvarchar data type with a maximum length of 450 characters. This field is used to store the unique identification number for the approval requirement associated with a particular Paylink transaction. It is designed to help identify and track the specific approval requirement that has been assigned to the Paylink, providing crucial information for tracking and auditing purposes. The maximum length of 450 characters allows for longer identification numbers to be stored, ensuring the accuracy and completeness of data. This field is an essential component of the Paylink table, providing important details for effective record-keeping and analysis."
    },
    "fullyApprovedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The user that gave the final approval for the paylink submission.",
      "format": "int32"
    },
    "fullyApprovedDate": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date and time the paylink submission received the final approval.",
      "format": "date-time"
    },
    "partiallyApprovedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The first approver that approved the paylink submission.",
      "format": "int32"
    },
    "partiallyApprovedDate": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date the paylink record was partially approved.",
      "format": "date-time"
    },
    "paymentValueDate": {
      "type": "string",
      "description": "The value date for the payments in the file.",
      "format": "date-time"
    },
    "submittedById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The person that submitted the paylink file.",
      "format": "int32"
    },
    "submittedDate": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date the paylink record was submitted for approval.",
      "format": "date-time"
    },
    "fullyApprovedBySystemAccountId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The FullyApprovedBySystemAccountId field is a integer data type in the Paylink table. This field contains the unique identifier for the account that has been fully approved by the system for use with the Paylink service. This account is deemed to have met all necessary requirements and has been fully verified by the system, making it authorized to complete transactions through Paylink. This field provides a quick and easy way to identify and keep track of fully approved accounts within the overall Paylink system. With this information easily accessible, businesses can ensure that only trusted accounts are being used for Paylink transactions, providing added security and peace of mind.",
      "format": "int32"
    },
    "partiallyApprovedBySystemAccountId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The PartiallyApprovedBySystemAccountId field in the Paylink table is a data type of integer and is used to track the partially-approved status of a payment transaction. This field contains the system-generated account ID for the entity responsible for partially approving the transaction. This allows for easy tracking of which accounts have been involved in the approval process and helps in troubleshooting any potential issues. The field also helps in identifying the level of approval that has been granted, whether partial or full, and tracks the progress of the transaction through the approval process. This data entry is crucial for ensuring accuracy and compliance in the payment process and enables effective monitoring and reporting of approval statuses.",
      "format": "int32"
    },
    "submittedBySystemAccountId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The SubmittedBySystemAccountId field in the Paylink table is a numerical data type that stores the unique identifier of the system account from which the Paylink was submitted. This field is used to track the source of the submission and provides important information for auditing and record-keeping purposes. It assists in identifying the responsible party for the creation and maintenance of the Paylink. The data type int ensures that the stored value is an integer, allowing for efficient handling and storage of large numbers. Overall, this field plays a vital role in the organization and management of Paylinks within the database.",
      "format": "int32"
    },
    "sentById": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The person that triggered the send action.",
      "format": "int32"
    },
    "sentDate": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date and time the file was sent to the bank indentified in the integration of the associated template.",
      "format": "date-time"
    },
    "accountInstitiuteName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The AccountInstituteName field in the Paylink table is used to store the name of the financial institution or organization associated with a specific account. This data type nvarchar allows for a maximum of 255 characters, providing enough space to accurately store the full name of the institute. This field is useful for tracking and organizing various accounts within the Paylink system, making it easily identifiable for users. The information stored in this field can be used for financial reporting, transaction history, and other administrative purposes."
    },
    "categoryPurposeId": {
      "maxLength": 450,
      "type": [
        "string",
        "null"
      ],
      "description": "The CategoryPurposeId field in the Paylink table is a nvarchar data type with a maximum length of 450 characters. This field is used to accurately classify the purpose of each payment within the category it falls under. By associating each payment with a specific purpose through this field, it allows for efficient tracking and organization of transactions within the Paylink system. The maximum length of 450 characters ensures that detailed descriptions can be provided for each purpose, providing a comprehensive understanding of the payment."
    },
    "pde": {
      "type": "boolean",
      "description": "The Pde field in the Paylink table is a bit data type that can store a boolean value representing either a true or false condition. This field is commonly used to indicate whether a payment has been successfully processed or not. A value of 1 signifies a successful transaction, while a value of 0 indicates a failed transaction. The Pde field plays a crucial role in accurately tracking and managing payment data within the Paylink table, providing a reliable indicator of payment status."
    },
    "accountInstitiuteLogoImage": {
      "type": [
        "string",
        "null"
      ],
      "description": "The AccountInstitiuteLogoImage field in the Paylink table is a data type nvarchar that stores the image of the institute logo associated with a particular account. It allows for customization and branding, providing a visual representation of the organization connected to the account. This field plays a key role in creating a professional and personalized experience for users interacting with the Paylink platform. The nvarchar data type allows for the storage of a wide range of image file formats, ensuring flexibility and compatibility."
    },
    "pdeBadge": {
      "maxLength": 4000,
      "type": [
        "string",
        "null"
      ],
      "description": "The PdeBadge field in the Paylink table is a nvarchar data type with a maximum length of 4000 characters. This field is designed to store a badge or identification number associated with an individual in the Paylink system. It can hold a variety of characters, including letters, numbers, and special characters, giving it the flexibility to accommodate various badge formats. The PdeBadge field is crucial for identifying and tracking individuals within the Paylink system, providing easy access to their personal information and transaction history. Its spacious length of 4000 characters allows for the storage of longer or more complex badge numbers, ensuring the accuracy and completeness of data stored in the Paylink table."
    },
    "cashflowId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The CashflowId field in the Paylink table is a data type Integer which serves as a unique identifier for each cashflow transaction. This field is used to link cashflow records to their corresponding paylinks, allowing for easy tracking of financial information within the database. The CashflowId is essential for accurately organizing and analyzing cashflow data, making it a vital component in the Paylink table.",
      "format": "int32"
    },
    "fullyApprovedByFirstNameLastName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The FullyApprovedByFirstNameLastName field in the Paylink table is a nvarchar data type that stores the first and last name of the individual who has given full approval for a transaction or action. This field is typically used in financial or managerial systems to track and document approvals for various processes. It is designed to provide a clear and concise record of the individual responsible for finalizing decisions or authorizing specific actions within the organization. This field allows for easy identification and verification of the individual approving a transaction, providing a comprehensive audit trail for tracking purposes."
    },
    "partiallyApprovedByFirstNameLastName": {
      "type": [
        "string",
        "null"
      ],
      "description": "PartiallyApprovedByFirstNameLastName is a field within the Paylink table that is of the data type nvarchar. This field is used to store the first and last name of an individual who has partially approved a payment request made through Paylink. This field allows for easy identification of partial approvals within the Paylink system and helps in tracking the progress of payment requests. By using the nvarchar data type, this field can store both letters and characters, ensuring flexibility and accuracy in recording the individual's name. Overall, PartiallyApprovedByFirstNameLastName plays a crucial role in the Paylink system by providing important information about partial approvals and contributing to efficient and organized payment processing."
    },
    "submittedByFirstNameLastName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The SubmittedByFirstNameLastName field in the Paylink table is of type nvarchar and is used to store the first and last name of the individual who submitted the paylink. This field allows for easy tracking and identification of the person responsible for creating the paylink. It also allows for proper attribution of the paylink to the correct person. This field is an essential component of the Paylink table and provides important information for record-keeping and analysis purposes."
    },
    "sentByFirstNameLastName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The SentByFirstNameLastName field in the Paylink table is a nvarchar (variable-length character) data type that stores the first name and last name of the sender of a payment link. This field is typically used to track and display the individual or organization responsible for initiating a payment request. It allows for easy identification and communication with the sender in case of any issues or inquiries. This field can accommodate a combination of letters, numbers, and special characters, making it versatile for storing a wide range of sender names."
    },
    "actionRequired": {
      "maxLength": 7,
      "minLength": 1,
      "type": "string",
      "description": "The 'ActionRequired' field in the 'Paylink' table is a type of varchar with a maximum length of 7 characters. This field is used to indicate any specific action that is needed for the paylink, such as 'approve' or 'reject'. It serves as a reminder for any necessary steps that need to be taken in order to process the paylink successfully. The limited length of 7 characters ensures that the information is concise and easily identifiable. This field is essential for keeping track of the status of paylinks and ensuring timely completion of necessary actions."
    },
    "accountIdentifier": {
      "type": [
        "string",
        "null"
      ],
      "description": "The AccountIdentifier field in the Paylink table is a string variable with a maximum length of the number of characters provided by the nvarchar data type. This field serves as a unique identifier for each account that is linked to the Paylink system. It can contain alphanumeric characters and special symbols, allowing for flexibility in creating and managing account numbers. This field is crucial in the organization and retrieval of payment information, and helps to ensure accuracy and security in financial transactions."
    },
    "ownerName": {
      "type": [
        "string",
        "null"
      ],
      "description": "The OwnerName field in the Paylink table is a data type nvarchar that stores the name of the owner associated with a specific payment link. This field can contain a combination of alphabetical characters, numbers, and special characters and has a maximum length of 255 characters. It is designed to provide a clear and concise way to identify the individual or organization that owns the payment link, allowing for easier tracking and management of payment transactions. This field can be used in conjunction with other fields in the Paylink table to provide a comprehensive understanding of the ownership and utilization of payment links within the system."
    },
    "accountCurrencyId": {
      "maxLength": 128,
      "type": [
        "string",
        "null"
      ],
      "description": "The AccountCurrencyId field in the Paylink table is a nvarchar data type with a maximum length of 128. This field serves to store the currency ID associated with an account within the Paylink system. It allows for efficient tracking and management of different currencies used for payments, conversions, and other financial transactions. With its ample length, this field can accommodate a variety of currency IDs, making it a versatile and robust component of the Paylink database."
    },
    "ownerLogoImage": {
      "type": [
        "string",
        "null"
      ],
      "description": "The OwnerLogoImage field in the Paylink table is a string field that stores the image of the owner's logo associated with the paylink. This data type allows for the storage of alphanumeric characters and can hold up to 4,000 characters. The image stored in this field can be used for visual identification and branding purposes within the paylink system. As an nvarchar data type, the OwnerLogoImage field can accommodate various character sets and special characters, providing flexibility for different logo designs. Storing the owner's logo in this field allows for easy retrieval and display within the paylink system, enhancing the overall user experience."
    },
    "headroomReportingAmount": {
      "type": [
        "number",
        "null"
      ],
      "description": "The HeadroomReportingAmount field in the Paylink table represents the total amount of headroom available for reporting purposes. This field is of data type decimal, allowing for precise and accurate calculations involving monetary values. It is used to track and monitor financial data, providing insights into the current financial standing of the company. This field is particularly useful for budgeting and planning purposes, as well as for identifying potential areas for cost-saving or revenue growth. The HeadroomReportingAmount field plays a crucial role in the financial analysis and decision-making processes within the organization.",
      "format": "double"
    },
    "attentionRequired": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "The AttentionRequired field in the Paylink table is used to signify if specific attention is required for a particular transaction. This field is of data type bit, which means it can have a value of either 0 or 1. A value of 0 indicates that no additional attention is needed, while a value of 1 indicates that further action or review may be necessary. This field is useful for quickly identifying transactions that require special handling or further investigation. It allows for streamlined processing and ensures that important transactions are not overlooked. The AttentionRequired field plays a crucial role in maintaining the accuracy and efficiency of the Paylink table."
    },
    "paylinkCategoryId": {
      "maxLength": 450,
      "minLength": 1,
      "type": "string",
      "description": "The PaylinkCategoryId field in the Paylink table is a nvarchar data type with a maximum length of 450 characters. This field is used to categorize the different types of paylinks that are stored in the table. Paylinks are an online payment method that allows users to send money or make payments from their bank account to another account. The PaylinkCategoryId field helps to organize and group paylinks based on their purpose or recipient, making it easier to manage and track transactions. This field is essential for accurately and efficiently processing financial transactions within the Paylink system."
    },
    "paylinkCategoryBadge": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string",
      "description": "The PaylinkCategoryBadge field within the Paylink table is an nvarchar data type with a maximum length of 256 characters. It is designed to display the category badge associated with each paylink. This badge serves as a visual representation of the category to which the paylink belongs, providing instant recognition and organization for the data. This field is essential for effective categorization and navigation within the Paylink table."
    },
    "fileName": {
      "minLength": 1,
      "type": "string",
      "description": "The FileName field in the Paylink table is a nvarchar data type that stores the name of a file associated with a payment transaction. This field provides a way to easily identify and access the specific file related to a payment within the table. It can contain a combination of letters, numbers, and special characters, with a maximum length determined by the nvarchar data type. The FileName field is essential for organizing and managing payment data and ensuring accurate record-keeping."
    },
    "documentId": {
      "type": "integer",
      "description": "The DocumentId field is an integer identifier that uniquely represents each document associated with a Paylink entry. This field serves as a primary key, ensuring that every record in the Paylink table can be distinctly referenced and retrieved, facilitating efficient data management and integrity within the database.",
      "format": "int32"
    }
  },
  "additionalProperties": false
}