API Reference

Client Integration Accounts

patch
https://app.financekey.com/OData/v_ClientIntegrationAccounts()

Defines a financial account.

Path Params
string
required
Body Params
int32

The ClientIntegrationId field is a unique identifier in the table named ClientIntegrationAccount. This field is of the data type int, which stands for integer, and is used to store numerical values. Each ClientIntegrationAccount record within the table will have a different integration ID assigned to it, ensuring the identification and differentiation of each client's integration account. This field is crucial for managing and organizing client data and facilitating efficient information retrieval. Additionally, the integration ID is essential for the integration process between the client's account and other systems or platforms. With the help of this field, the integration account can be quickly identified and linked to its corresponding client record.

int32

The ConsentId field in the table ClientIntegrationAccount is an integer data type that stores a unique identifier for each client's consent. This field is used to track the consent given by clients for integrating their accounts with the system. The ConsentId is essential for maintaining the security and privacy of the client's data as it ensures that only authorized accounts can be linked to the integrated system. This field is crucial for providing a seamless and secure experience for both the clients and the integrated system.

string | null

The APIReference field in the ClientIntegrationAccount table is a primary key field used to uniquely identify each client integration account within the database. It has a data type of nvarchar, allowing for storing any combination of letters, numbers, and special characters. The maximum length for this field is 36 characters, providing ample space for referencing and identifying specific client integration accounts. This field is crucial for maintaining accurate and efficient record-keeping of client integration accounts and is indexed for quick retrieval and data manipulation.

string
required
length ≥ 1

The OwnerName field in the ClientIntegrationAccount table is a data type nvarchar, which means it can store values containing both letters and numbers. This field is designed to store the name of the owner or main contact for the client's integration account. It can hold up to 255 characters and is an essential piece of information for managing and organizing client data. The OwnerName field allows for easy identification and communication with the main point of contact for each client, ensuring smooth integration processes and effective client management.

int32

The ConsentAccountId is a unique primary key field within the ClientIntegrationAccount table, denoting an integer value that is assigned to each individual client account. This field serves as a fundamental identifier for each account and ensures data integrity and accurate record keeping within the database. As a primary key, the ConsentAccountId cannot be duplicated or left blank, and it is used in conjunction with other fields to establish relationships and references between tables. This data type is essential in efficiently managing and accessing client account information for integration and consent purposes.

int32

The internal id for the account.

string | null

The OwnerLogoImage field in the ClientIntegrationAccount table is a data type of nvarchar, representing the logo or graphic associated with the owner of the account. This field allows for the storage and display of the owner's logo or image, which can provide visual branding and identification within the integration platform. It is designed to enhance the overall user experience and promote brand recognition. The nvarchar data type allows for the storage of a string of characters, making it a versatile option for a variety of logo or image file formats.

string
required
length ≥ 1

The AccountIdentifier field in the ClientIntegrationAccount table is a nvarchar data type that stores a unique identifier for each client. This identifier is typically used for integration purposes and allows for seamless communication between the client and the company. The value in this field serves as a primary key and is essential in identifying and accessing specific client information within the database.

string
required
length ≥ 1

The InstitiuteName field in the ClientIntegrationAccount table is a variable-length string data type (nvarchar) that stores the name of the institute associated with a particular client. This field is designed to hold a wide range of characters and allows for the inclusion of special characters, making it suitable for the storage of institute names from different languages or with unique naming conventions. It plays a key role in identifying and organizing client data within the integration process, allowing for efficient data management and record keeping.

string
required
length ≥ 1

The AccountReference field is an nvarchar data type that stores a unique identifier or reference code for each account. It allows for alphanumeric characters and can accommodate variable-length strings, providing a flexible way to track and manage account-specific information. This field is essential for referencing accounts in external systems or integrating with other databases, ensuring that each account can be accurately identified and retrieved.

string | null

The LogoImage field in the ClientIntegrationAccount table is a data type nvarchar, which stores a variable-length string of characters that represents the URL or filepath of a company's logo image. This field is used for visually representing the client's brand in any integrated systems, such as online platforms or marketing materials. The nvarchar data type allows for Unicode characters, ensuring that the logo image can accurately reflect any non-standard characters associated with the client's brand. This field is a crucial element in maintaining consistency and brand recognition across different platforms and channels for the client's integration purposes.

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