API Reference

Account Balance Integrity

post
https://app.financekey.com/OData/v_AccountBalanceIntegrityChecks

Shows account balances along with an integrity message high-lighting potential problems with the consistency of the data.

Body Params
int32

The AccountBalanceId field is a crucial component of the AccountBalanceIntegrityCheck table, serving as the primary key and data storage type of integer. This unique identifier ensures that each record in the table can be easily accessed and identified without any duplication or overlapping. As the table is responsible for maintaining the integrity of all account balances, the AccountBalanceId holds a significant role in ensuring the accuracy and consistency of data. With this key field, any changes or updates to the account balances can be effectively tracked and linked back to its original source. This makes the AccountBalanceId field a critical element in maintaining the overall integrity and reliability of the AccountBalanceIntegrityCheck table.

int32 | null

The AccountId field in the AccountBalanceIntegrityCheck table is an integer data type that stores unique identification numbers for each account. This field is used to maintain the integrity of account balances by linking them to their corresponding account numbers. The values in this field are essential for accurately tracking and managing financial transactions within the database. With the help of the AccountId field, users can easily retrieve and update account balances without any discrepancies. This field serves as a crucial component in maintaining the accuracy and reliability of financial data in the database.

double
required

The field OpeningBalance in the table AccountBalanceIntegrityCheck stores a decimal value that represents the initial balance of an account. This field is crucial for maintaining the integrity of account balances, as it serves as a starting point for all financial transactions recorded in the table. The decimal data type allows for precise and accurate balance calculations, ensuring the accuracy and reliability of financial data. Any changes or updates to this field should be carefully monitored to ensure the overall integrity of the account balance records.

double
required

ClosingBalance is a field in the AccountBalanceIntegrityCheck table that stores the final balance of a specific account. It is of the data type decimal, allowing for precise and accurate tracking of the account's balance. This field is critical for ensuring the integrity of financial data, as it serves as a comparison point for all other transactions on the account. The ClosingBalance field plays a crucial role in auditing and maintaining the accuracy of account balances. It is an essential component for financial record-keeping and analysis.

double | null

The BalanceDifference field in the AccountBalanceIntegrityCheck table is a decimal data type used to store the difference between the current balance and the expected balance for a particular account. This field is used to perform integrity checks and ensure the accuracy of account balances. It provides important information for identifying discrepancies and tracking discrepancies over time. The BalanceDifference field is an essential component of maintaining the overall balance integrity of the accounts in the database.

double
required

The TransactionAmountSum field is a decimal data type that is featured in the AccountBalanceIntegrityCheck table. This field displays the total sum of all the transaction amounts within a given account. It provides a comprehensive overview of the overall activity and balance within the account, aiding in the identification of potential discrepancies or errors. This field ensures the integrity of the account's balance by accurately calculating the total amount of all transactions. This critical data can assist in monitoring financial health and detecting any irregularities in account activity.

double | null

The TransactionToBalanceDifference field in the AccountBalanceIntegrityCheck table holds decimal values that represent the difference between the current account balance and the total of all transactions on that account. This field is crucial for ensuring the integrity of the account balance and detecting any discrepancies or errors in transactions. It is used for reconciling and auditing purposes to ensure the accuracy of financial records. As a decimal data type, it allows for precise calculations and comparisons to be made. Any significant differences in this field may indicate potential issues with the account balance and prompt further investigation.

string | null

The IntegrityMessage field in the AccountBalanceIntegrityCheck table is a varchar data type with a maximum length of 75 characters. This field is used to store descriptive messages related to the integrity check of the account balance. It can contain information such as the results of the check or any errors that were encountered. This field is important for maintaining the accuracy and reliability of the account balance data in the table.

string | null

The Content field in the AccountBalanceIntegrityCheck table is of data type nvarchar, a variable length string data type capable of storing up to 4,000 characters. This field is designed to hold textual data such as notes, comments, or descriptions related to the integrity check of a particular account balance. It allows for flexibility in storing information and can accommodate various types and lengths of data, making it useful for recording important details about the account balance verification process. This field is essential in ensuring the accuracy and reliability of the data in the AccountBalanceIntegrityCheck table.

date-time
required

The AsOf field in the AccountBalanceIntegrityCheck table is of data type datetime2 and stores the date and time at which the account balance was last checked for data integrity. This field is essential for tracking the accuracy of financial data over a period of time and ensuring that any changes to the account balance are accurately recorded. The AsOf field serves as a reference point for auditing and analyzing the account balance, allowing for timely identification and resolution of any inconsistencies or errors. It plays a crucial role in maintaining the integrity and reliability of financial data for the AccountBalanceIntegrityCheck table.

date-time
required

The StatementDate field in the AccountBalanceIntegrityCheck table is a date type field that records the date on which a statement was issued for the account balance. This field is important for maintaining the integrity of account balances and ensuring accurate and up-to-date financial information. The StatementDate field allows for easy tracking and verification of when statements were generated, providing a clear audit trail of account activity. It is a vital component in maintaining accurate records and promoting financial transparency within your organization.

int32

The field SystemDefnId in the table AccountBalanceIntegrityCheck is a required integer data type that serves as a unique identifier for a specific definition within the system. This field is typically used to track and maintain the accuracy of account balances and ensure the integrity of financial data. It serves as an essential piece of information for conducting audits and ensuring the proper functioning of the system. The values stored in this field can be used to cross-reference with other tables or systems to ensure consistency and accuracy in financial records.

double
required

The ReportingClosingBalance field in the AccountBalanceIntegrityCheck table is a decimal data type that stores the final balance for a specific account at a given reporting period. This field is essential for ensuring the accuracy and integrity of financial records, as it serves as a reference point for tracking changes and discrepancies in account balances over time. The decimal data type allows for precise calculations and comparisons of account balances, making it a crucial component for maintaining financial accuracy and transparency. Any discrepancies in the ReportingClosingBalance field may indicate errors or potential fraudulent activity, making it a vital tool for maintaining the reliability and trustworthiness of financial data.

double
required

The ReportingOpeningBalance field in the AccountBalanceIntegrityCheck table is a decimal data type that stores the initial balance of an account at the beginning of a reporting period. This field is essential for maintaining the accuracy and integrity of financial data, as it serves as a reference point for comparing and verifying subsequent transactions. The decimal data type allows for precise and accurate calculations, ensuring the reliability of the reported account balances. This field is critical for financial reporting and analysis, providing insights into the financial health and performance of an organization.

double | null

The ReportingBalanceDifference field in the AccountBalanceIntegrityCheck table stores a decimal value representing the difference between the reported account balance and the actual account balance. This field is used to ensure the accuracy and integrity of the financial data by highlighting any discrepancies between the reported balance and the actual balance. The decimal data type allows for precise measurement of even the smallest differences, making it ideal for tracking and identifying any deviations in account balances. This field plays a crucial role in maintaining the integrity and reliability of financial reporting within the database.

string
required
length ≥ 1

The Reference field in the table AccountBalanceIntegrityCheck is a data type of nvarchar, which stores alphanumeric characters and can hold up to 4000 characters in length. This field serves as a reference point for the integrity check of an account's balance. It may contain a unique identifier, such as an account number or a transaction ID, to aid in identifying and verifying the accuracy of the account's balance. This field is essential for maintaining the integrity and reliability of the account balance data in the table, ensuring that any discrepancies or errors can be easily traced and resolved.

string
required
length between 1 and 128

The CurrencyId field in the AccountBalanceIntegrityCheck table is a nvarchar data type with a maximum length of 128. This field is used to store the unique identifier of the currency associated with an account balance. It allows for accurate tracking and management of account balances in different currencies within the database. The CurrencyId field is essential for ensuring the integrity of financial data and ensuring accurate currency conversions.

string
required
length between 1 and 128

The AccountTypeId field in the AccountBalanceIntegrityCheck table is of data type nvarchar with a maximum length of 128 characters. This field is used to store the unique identifier for the type of account associated with the balance. It is used in the process of ensuring the integrity of account balances by verifying the account type and ensuring it matches the appropriate balance information. The field provides important information for accurately tracking and managing account balances in the system.

string
required
length between 1 and 128

The Code field in the AccountBalanceIntegrityCheck table is a nvarchar data type with a maximum length of 128 characters. This field is used to store a unique code or identifier for each record in the table. It is designed to help maintain the integrity of the account balance data by providing a consistent and easily identifiable reference for each entry. The nvarchar data type allows for both numeric and alphanumeric characters to be stored in the field, making it flexible and suitable for various types of codes. The maximum length of 128 characters ensures that the code is long enough to accurately represent the record, but not too lengthy to cause storage issues. Overall, the Code field serves as an important component in ensuring the accuracy and organization of account balance data in the AccountBalanceIntegrityCheck table.

string
required
length ≥ 1

The Name field in the AccountBalanceIntegrityCheck table is of the nvarchar data type, which stands for 'national varchar'. This means it can store strings of text that may contain characters from different language sets. This field is used to identify the account name associated with a specific balance integrity check. The nvarchar data type allows for a maximum of 4,000 characters, providing sufficient space to input a wide range of account names. This field is important in maintaining accurate and organized account balance data, ensuring the integrity and reliability of financial information.

boolean | null

The Latest field in the AccountBalanceIntegrityCheck table stores a bit of data, representing whether or not the account's balance has been recently updated. A bit data type is a binary value that can hold the values of 0 or 1, making it ideal for representing a simple yes or no flag. This field can be used to ensure the accuracy and consistency of account balance information within the database.

boolean | null

The ActiveAccount field in the AccountBalanceIntegrityCheck table is a data type bit that indicates whether or not an account is currently active and available for use. This field is used to verify the integrity of account balances and ensure that only active accounts are included in financial calculations. The value of 1 represents an active account, while a value of 0 indicates an inactive account. This field plays a crucial role in maintaining accurate financial records and ensuring data consistency.

double
required

The WithheldBalance field in the AccountBalanceIntegrityCheck table stores a decimal value that represents the amount of funds held or retained in an account. This field is used to ensure data integrity by accurately tracking any withheld balances, which may be adjusted due to pending transactions, fees, or other factors. By storing this information in decimal format, precise and accurate calculations can be made to verify the overall balance of the account. The WithheldBalance field plays a crucial role in maintaining the accuracy and reliability of the data in the AccountBalanceIntegrityCheck table.

double
required

The ReportingWithheldBalance field is a decimal data type that is incorporated into the AccountBalanceIntegrityCheck table. It stores information related to any amount of money that has been withheld for reporting purposes. This field is important for maintaining accuracy and integrity in the account balance data. It provides a clear and transparent representation of any funds that have been held back for reporting purposes, allowing for efficient and reliable tracking of account balances.

double | null

The AvailableReportingClosingBalance field in the AccountBalanceIntegrityCheck table is a decimal data type that stores the final calculated balance for an account. This balance is the available amount that can be reported on for financial reporting purposes. It is important for ensuring the accuracy and integrity of account balances and serves as a benchmark for tracking changes in an account's financial health over time. This field is crucial for financial analysis and decision-making and plays a vital role in maintaining the reliability and validity of an organization's financial data.

double | null

The AvailableReportingOpeningBalance field is designed to store a numerical value of type decimal in the AccountBalanceIntegrityCheck table. This field represents the current balance available for reporting purposes and is essential for maintaining accurate account balance records. The decimal data type ensures precision and accuracy in representing monetary values. This field is crucial for financial reporting and account reconciliation processes, providing a comprehensive overview of the organization's financial standing. It enables easy tracking and analysis of account balances, ensuring the integrity of financial data.

double | null

The AvailableClosingBalance field in the AccountBalanceIntegrityCheck table is of decimal data type and represents the current balance of an account at the end of a specified period. This field provides an accurate and up-to-date record of the amount of funds available for transactions or withdrawals. It is an essential component in ensuring the integrity of an account's balance and can help to identify any discrepancies or errors. This field may also be used for budgeting and forecasting purposes, providing valuable insights into a person's or organization's financial health.

double | null

The AvailableOpeningBalance field within the AccountBalanceIntegrityCheck table is of the decimal data type. This field stores the available balance for a specific account at the beginning of a given time period. It is important for maintaining the accuracy and integrity of account balances, as it serves as a reference point for future calculations and audits. This field allows for precise tracking and analysis of the changes in account balances over time. Its data type of decimal ensures that even small fractions of a unit can be accurately recorded, providing a comprehensive and detailed record of a account's financial history.

string
required
length ≥ 1

The OwnerName field in the AccountBalanceIntegrityCheck table stores the name of the owner associated with the account. It has a data type of nvarchar, meaning it can hold a maximum of 4,000 characters. This field is crucial for maintaining the integrity of the account balance information, as it helps to accurately identify the owner and their corresponding financial data. It will most likely be populated with full names, but can also accommodate special characters and symbols if needed. Overall, the OwnerName field plays a vital role in ensuring accurate and reliable account balance information.

string | null

The OwnerLogo field in the AccountBalanceIntegrityCheck table is a nvarchar type, meaning it can hold a maximum of 4000 characters of Unicode data. This field is used to store the logo of the account owner, typically represented in image format. It can be used for visual identification and organization of account data within the table. The use of nvarchar allows for compatibility with various languages and characters, making it a versatile option for storing logo data. This field is essential for maintaining the accuracy and integrity of account data within the table.

string | null

BusinessUnitDescription is a field in the AccountBalanceIntegrityCheck table that is used to store descriptive information about the specific business unit associated with an account balance. It is of data type nvarchar, allowing for the input of both text and numeric values, with a maximum length of 256 characters. This field provides a brief overview of the business unit's purpose or function, providing context for the associated account balance. It allows for easier organization and identification of account balances by providing key information about the corresponding business unit.

string | null

The AccountUrl field in the AccountBalanceIntegrityCheck table is a varchar data type with a maximum length of 63 characters. This field is used to store the URL associated with the account, providing a direct link to access and review the account's balance information. By storing this information in the database, users can easily navigate to the associated account and ensure the integrity of the balance data. This field is essential for maintaining accurate and up-to-date financial records.

string | null

The AccountBalanceUrl field in the AccountBalanceIntegrityCheck table is a varchar data type with a maximum length of 70. This field stores the URL associated with a particular account's balance, ensuring the integrity and accuracy of financial records. It allows for easy access and verification of account balances, making it a crucial component for financial data management. The limited length ensures that the URL is concise and relevant to the account in question.

string | null

The SystemName field is designed to store the name of the system associated with each account balance integrity check. This field uses the nvarchar data type to support variable-length Unicode string data, allowing for the inclusion of a wide range of characters and symbols. It is intended to provide clear identification of the system involved in the integrity check process, enabling efficient tracking and management of account balance verifications across different systems.

Response
200

OK

Updated about 1 year ago

Language
URL
Response 
Click Try It! to start a request and see the response here!
Updated about 1 year ago