FinanceKey · Schema
FinanceKey.Entity.ConsentPkg.v_ClientIntegrationStatus
FinanceTreasuryArtificial IntelligencePaymentsCash Management
Properties
| Name | Type | Description |
|---|---|---|
| createdById | integernull | The identity of the account that created the initial record. |
| createdOn | string | The date and time the record was initially created. |
| updatedById | integernull | The identity of the account that last modified the record. |
| updateOn | string | The date and time the record was last modified. |
| closedById | integernull | The identity of the account that deactivated and closed the record. |
| closedOn | string | The date and time the record is to be considered as inactive and closed. |
| active | boolean | A flag that shows if the record is currently active. This values is calculated based on the current date and the record closed date. |
| rowVersion | stringnull | A unique version stamp of the record. |
| sessionId | stringnull | The identity of the session that last modified the record. |
| clientIntegrationStatusId | integer | The ClientIntegrationStatusId field is an identity field that is used in the ClientIntegrationStatus table to uniquely identify each record. This field is of data type int, which means that it can sto |
| clientIntegrationId | integer | The ClientIntegrationId field is an integer data type that can be found in the ClientIntegrationStatus table. This field serves as a unique identifier for each client's integration status in a system. |
| integrationInstituteId | integer | The IntegrationInstituteId field is an integer data type in the ClientIntegrationStatus table. It contains a unique identifier for the institute to which the client's integration status belongs. This |
| intervalId | stringnull | The IntervalId field in the ClientIntegrationStatus table is a string data type that can hold a maximum of 32 characters. It is used to store a unique identifier for the interval at which the client i |
| clientEnvironmentId | integer | The ClientEnvironmentId field in the ClientIntegrationStatus table is an integer data type that serves as a unique identifier for a specific client environment. This field allows for the tracking and |
| logCount | integer | The LogCount field in the ClientIntegrationStatus table is a numeric field of the int data type. It is used to track the number of logs recorded for a particular client's integration status. This fiel |
| successCount | integer | The SuccessCount field is an integer data type that belongs to the table called ClientIntegrationStatus. It is used to track the number of successful integrations that have been performed for a client |
| errorCount | integer | The ErrorCount field in the ClientIntegrationStatus table is a data type of int and is used to keep track of the number of errors that occur during the integration process for a client. This field is |
| stateId | stringnull | The StateId field in the ClientIntegrationStatus table is a nvarchar data type with a maximum length of 450 characters. It stores the unique identification code for a specific state within a country. |
| asOf | string | The AsOf field in the ClientIntegrationStatus table is a datetime2 data type that tracks the date and time the integration status was last updated or checked for a specific client. This field is cruci |
| comment | stringnull | Miscellaneous notes and information for the entry or record. |
| intervalClientIntegrationStatusIntervalId | stringnull | The IntervalClientIntegrationStatusIntervalId is a field within the ClientIntegrationStatus table that stores a string of characters, with a maximum length of 32, representing the unique Interval Id a |
| clientItemId | integernull | The ClientItemId field in the ClientIntegrationStatus table stores a unique identifying number for each client integrated into the system. This field has a data type of int, meaning it can only hold i |
| stateSelectStringValueId | stringnull | The StateSelectStringValueId field in the ClientIntegrationStatus table is of data type nvarchar and can hold a maximum of 450 characters. This field is used to store a string value representing the s |
| stateDescription | stringnull | The StateDescription field in the ClientIntegrationStatus table is a nvarchar data type with a maximum length of 256 characters. This field is used to provide a detailed description of the current int |
| stateBadgeImage | stringnull | The StateBadgeImage field in the ClientIntegrationStatus table is a nvarchar data type with a maximum length of 256 characters. This field stores the image that represents the status of a client's int |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-consent-pkg-v-client-integration-status-schema.json",
"title": "FinanceKey.Entity.ConsentPkg.v_ClientIntegrationStatus",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/financekey-consents-api-openapi.yml#/components/schemas/FinanceKey.Entity.ConsentPkg.v_ClientIntegrationStatus",
"required": [
"asOf"
],
"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
},
"clientIntegrationStatusId": {
"type": "integer",
"description": "The ClientIntegrationStatusId field is an identity field that is used in the ClientIntegrationStatus table to uniquely identify each record. This field is of data type int, which means that it can store numerical values up to 2,147,483,647. This field is automatically generated by the database system and assigned to new records as they are inserted into the table. The purpose of this field is to provide a unique identifier for each record in the ClientIntegrationStatus table, making it easier for users to retrieve and manipulate specific data. This field is essential for efficiently managing and organizing data in the ClientIntegrationStatus table, making it an integral part of the database structure.",
"format": "int32"
},
"clientIntegrationId": {
"type": "integer",
"description": "The ClientIntegrationId field is an integer data type that can be found in the ClientIntegrationStatus table. This field serves as a unique identifier for each client's integration status in a system. It is used to track the progress of integration between the client's systems and the larger system. Each integration status is assigned a specific identification number to ensure accurate and efficient tracking. This field is essential for monitoring and updating the integration status of a client, as well as identifying any potential issues that may arise during the integration process.",
"format": "int32"
},
"integrationInstituteId": {
"type": "integer",
"description": "The IntegrationInstituteId field is an integer data type in the ClientIntegrationStatus table. It contains a unique identifier for the institute to which the client's integration status belongs. This field is crucial for tracking and managing the integration progress of clients from different institutes. It allows for easy organization and categorization of integration statuses based on their associated institute.",
"format": "int32"
},
"intervalId": {
"maxLength": 32,
"type": [
"string",
"null"
],
"description": "The IntervalId field in the ClientIntegrationStatus table is a string data type that can hold a maximum of 32 characters. It is used to store a unique identifier for the interval at which the client integration status is being recorded or updated. This field can be used to track the frequency of updates for each client in the integration process."
},
"clientEnvironmentId": {
"type": "integer",
"description": "The ClientEnvironmentId field in the ClientIntegrationStatus table is an integer data type that serves as a unique identifier for a specific client environment. This field allows for the tracking and organization of client environments within the integration status table. Each client environment will have its own unique ClientEnvironmentId, providing a clear and distinct reference point for any changes or updates in the integration status. This field is crucial in maintaining accurate and efficient management of client integration processes.",
"format": "int32"
},
"logCount": {
"type": "integer",
"description": "The LogCount field in the ClientIntegrationStatus table is a numeric field of the int data type. It is used to track the number of logs recorded for a particular client's integration status. This field provides vital information on the frequency and volume of data transfers for each client, allowing for efficient monitoring and troubleshooting of integration processes. The value of this field increases every time a log is recorded, providing a comprehensive overview of the client's integration activity.",
"format": "int32"
},
"successCount": {
"type": "integer",
"description": "The SuccessCount field is an integer data type that belongs to the table called ClientIntegrationStatus. It is used to track the number of successful integrations that have been performed for a client within a specific time frame. This field is crucial for monitoring and analyzing the performance of client integrations and ensuring that all systems are running smoothly. The SuccessCount field serves as a key indicator of the overall success and efficiency of the integration process for each individual client. It can also be used to identify any potential issues or areas for improvement. With the help of the SuccessCount field, businesses can maintain high levels of customer satisfaction and trust by ensuring timely and error-free integrations.",
"format": "int32"
},
"errorCount": {
"type": "integer",
"description": "The ErrorCount field in the ClientIntegrationStatus table is a data type of int and is used to keep track of the number of errors that occur during the integration process for a client. This field is important for identifying any issues that may arise and to help troubleshoot and fix them. The higher the number in the ErrorCount field, the more errors have occurred during integration. This field allows for easy monitoring and analysis of the integration status for each client.",
"format": "int32"
},
"stateId": {
"maxLength": 450,
"type": [
"string",
"null"
],
"description": "The StateId field in the ClientIntegrationStatus table is a nvarchar data type with a maximum length of 450 characters. It stores the unique identification code for a specific state within a country. This field is used to indicate the current integration status of a client, allowing for easy tracking and management of clients at the state level. It serves as a crucial link between the client and their associated state, providing important information for reporting and analysis purposes."
},
"asOf": {
"type": "string",
"description": "The AsOf field in the ClientIntegrationStatus table is a datetime2 data type that tracks the date and time the integration status was last updated or checked for a specific client. This field is crucial for keeping accurate records and monitoring the progress of the integration process. It allows for time-sensitive analysis and enables efficient tracking of any changes or updates to a client's integration status. The data stored in this field can be used to ensure timely communication and provide valuable insights and statistics on the status of clients' integration.",
"format": "date-time"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Miscellaneous notes and information for the entry or record."
},
"intervalClientIntegrationStatusIntervalId": {
"maxLength": 32,
"type": [
"string",
"null"
],
"description": "The IntervalClientIntegrationStatusIntervalId is a field within the ClientIntegrationStatus table that stores a string of characters, with a maximum length of 32, representing the unique Interval Id associated with a particular client's integration status. This field is used to track the intervals, or time periods, during which the integration status of the client was updated. This allows for easier tracking and monitoring of a client's integration progress."
},
"clientItemId": {
"type": [
"integer",
"null"
],
"description": "The ClientItemId field in the ClientIntegrationStatus table stores a unique identifying number for each client integrated into the system. This field has a data type of int, meaning it can only hold integer values. The ClientItemId is crucial for tracking and managing the integration status of each client, including any issues or errors encountered during the integration process. It facilitates efficient and accurate identification of clients, making it a vital component of the database.",
"format": "int32"
},
"stateSelectStringValueId": {
"maxLength": 450,
"type": [
"string",
"null"
],
"description": "The StateSelectStringValueId field in the ClientIntegrationStatus table is of data type nvarchar and can hold a maximum of 450 characters. This field is used to store a string value representing the state of a client's integration status. It can be used to track the progress of data integration for a client, such as 'In Progress', 'Completed', or 'Failed', among others. This allows for efficient monitoring and management of the integration process for each client."
},
"stateDescription": {
"maxLength": 256,
"type": [
"string",
"null"
],
"description": "The StateDescription field in the ClientIntegrationStatus table is a nvarchar data type with a maximum length of 256 characters. This field is used to provide a detailed description of the current integration state of a client. This can include information such as the status of data syncing, any errors encountered, and any necessary actions that need to be taken for successful integration. The StateDescription field is crucial for tracking and managing client integration processes, ensuring smooth and efficient integration for all clients."
},
"stateBadgeImage": {
"maxLength": 256,
"type": [
"string",
"null"
],
"description": "The StateBadgeImage field in the ClientIntegrationStatus table is a nvarchar data type with a maximum length of 256 characters. This field stores the image that represents the status of a client's integration. It contains a visual indicator, such as a badge or icon, that represents whether the client's integration is active, pending, or completed. This field is used for tracking the progress of a client's integration and helps in quickly identifying any issues or delays in the process. It provides a visual reference for the current integration status and can be easily updated as the integration progresses."
}
},
"additionalProperties": false
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/financekey-finance-key-entity-consent-pkg-v-client-integration-status"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.