FinanceKey · Schema
FinanceKey.Entity.CreditFacilityPkg.v_CreditFacilityUsage
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. |
| creditFacilityUsageId | integer | The CreditFacilityUsageId field is an integer data type field in the CreditFacilityUsage table. This field contains unique identifiers for each row in the table and is used as a primary key by the dat |
| creditFacilityId | integer | The credit facility for which usage record has been generated. |
| facilityAmount | number | The amount of the facility at the time of the usage. |
| facilityCurrencyId | stringnull | The currency of the facility when the usage record was created. |
| date | string | The date stamp of the usage |
| accountId | integernull | AccountId is an int data type field in the CreditFacilityUsage table which stores a unique identifier for an account related to the credit facility usage. |
| reportingFacilityAmount | number | The amount of the credit facility in the company reporting currency. |
| reportingFacilityUsageAmount | number | The amount of the facility used in the company reporting currency. |
| reportingFacilityOpeningUsageAmount | number | The ReportingFacilityOpeningUsageAmount field in the CreditFacilityUsage table contains the opening usage amount of a particular reporting facility, expressed in terms of a decimal value. |
| availableAmount | numbernull | The AvailableAmount field in the CreditFacilityUsage table is a data type that stores the remaining balance or credit amount available for a particular credit facility. This field is typically express |
| comment | stringnull | Miscellaneous notes and information for the entry or record. |
| reportingAvailableAmount | numbernull | ReportingAvailableAmount is a field in the CreditFacilityUsage table that stores a decimal number representing the available amount of credit associated with an account. |
| usagePercent | numbernull | The UsagePercent field in the CreditFacilityUsage table stores the percentage of allocated funds used towards a particular credit facility. The value is a decimal number ranging between 0 and 1 (inclu |
| availablePercent | numbernull | AvailablePercent is a decimal field in the CreditFacilityUsage table that specifies the percentage of a credit facility that remains available for use. |
| facilityCurencyCurrencyCode | string | FacilityCurrencyCurrencyCode is a field in the CreditFacilityUsage table. It is an nvarchar data type with a maximum length of 128, and stores the code of the currency used in the associated credit fa |
| latest | booleannull | The Latest field in the CreditFacilityUsage table contains a binary value indicating whether or not the record is the most recent available credit facility usage. A value of 1 (true) indicates that th |
| referenceNumber | stringnull | ReferenceNumber is a data field of type nvarchar with a maximum length of 64 characters in the CreditFacilityUsage table. This field serves as an alphanumeric identifier for a specific credit facility |
| creditFacilityTypeId | stringnull | CreditFacilityTypeId is an nvarchar field in the CreditFacilityUsage table with a maximum length of 64 characters. It is used to differentiate the type of credit facility being used by a customer, suc |
| creditFacilityStateId | stringnull | The CreditFacilityStateId field of data type nvarchar in the CreditFacilityUsage table is used to store the unique identifier of the current state of a specific credit facility. It stores a maximum of |
| accountReference | stringnull | AccountReference for CreditFacilityUsage is a field of type nvarchar which holds a reference to a specific account that utilizes a given Credit Facility. |
| debtorName | string | DebtorName is an nvarchar field in the CreditFacilityUsage table that stores the name of the debtor associated with the associated CreditFacilityUsage record. |
| debtorId | integer | DebtorId is an integer data field in the CreditFacilityUsage table which identifies the unique debtor associated with the credit facility usage record. |
| debtorLogoImage | stringnull | DebtorLogoImage is an nvarchar field in CreditFacilityUsage table, which stores the logo of a debtor as an image in the database. |
| lenderName | string | This field stores the name of the lender for the credit facility associated with each record in the CreditFacilityUsage table. The data type is nvarchar so that both regular text strings and Unicode s |
| lenderLogoImage | stringnull | The LenderLogoImage field of the CreditFacilityUsage table stores the filename of the associated lender's logo image. This field is formatted as a nvarchar data type to store filenames with special ch |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/financekey/json-schema/financekey-finance-key-entity-credit-facility-pkg-v-credit-facility-usage-schema.json",
"title": "FinanceKey.Entity.CreditFacilityPkg.v_CreditFacilityUsage",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/financekey-credit-facilities-api-openapi.yml#/components/schemas/FinanceKey.Entity.CreditFacilityPkg.v_CreditFacilityUsage",
"required": [
"date",
"debtorName",
"facilityAmount",
"facilityCurencyCurrencyCode",
"lenderName",
"reportingFacilityAmount",
"reportingFacilityOpeningUsageAmount",
"reportingFacilityUsageAmount"
],
"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
},
"creditFacilityUsageId": {
"type": "integer",
"description": "The CreditFacilityUsageId field is an integer data type field in the CreditFacilityUsage table. This field contains unique identifiers for each row in the table and is used as a primary key by the database to ensure that there is only one entry for each CreditFacilityUsage record. This field is automatically populated in order to uniquely identify the entries in the table.",
"format": "int32",
"readOnly": true
},
"creditFacilityId": {
"type": "integer",
"description": "The credit facility for which usage record has been generated.",
"format": "int32"
},
"facilityAmount": {
"type": "number",
"description": "The amount of the facility at the time of the usage.",
"format": "double"
},
"facilityCurrencyId": {
"type": [
"string",
"null"
],
"description": "The currency of the facility when the usage record was created."
},
"date": {
"type": "string",
"description": "The date stamp of the usage",
"format": "date-time"
},
"accountId": {
"type": [
"integer",
"null"
],
"description": "AccountId is an int data type field in the CreditFacilityUsage table which stores a unique identifier for an account related to the credit facility usage.",
"format": "int32"
},
"reportingFacilityAmount": {
"type": "number",
"description": "The amount of the credit facility in the company reporting currency.",
"format": "double"
},
"reportingFacilityUsageAmount": {
"type": "number",
"description": "The amount of the facility used in the company reporting currency.",
"format": "double"
},
"reportingFacilityOpeningUsageAmount": {
"type": "number",
"description": "The ReportingFacilityOpeningUsageAmount field in the CreditFacilityUsage table contains the opening usage amount of a particular reporting facility, expressed in terms of a decimal value.",
"format": "double"
},
"availableAmount": {
"type": [
"number",
"null"
],
"description": "The AvailableAmount field in the CreditFacilityUsage table is a data type that stores the remaining balance or credit amount available for a particular credit facility. This field is typically expressed as a decimal number with two digits after the decimal point. It allows for easy tracking and monitoring of the funds that are still available for use within a credit facility. This information is vital for making financial decisions and managing credit usage.",
"format": "double"
},
"comment": {
"type": [
"string",
"null"
],
"description": "Miscellaneous notes and information for the entry or record."
},
"reportingAvailableAmount": {
"type": [
"number",
"null"
],
"description": "ReportingAvailableAmount is a field in the CreditFacilityUsage table that stores a decimal number representing the available amount of credit associated with an account.",
"format": "double"
},
"usagePercent": {
"type": [
"number",
"null"
],
"description": "The UsagePercent field in the CreditFacilityUsage table stores the percentage of allocated funds used towards a particular credit facility. The value is a decimal number ranging between 0 and 1 (inclusive), where 0 means the full amount of facility has not been used and 1 means that the full amount of facility has been used.",
"format": "double"
},
"availablePercent": {
"type": [
"number",
"null"
],
"description": "AvailablePercent is a decimal field in the CreditFacilityUsage table that specifies the percentage of a credit facility that remains available for use.",
"format": "double"
},
"facilityCurencyCurrencyCode": {
"maxLength": 128,
"minLength": 1,
"type": "string",
"description": "FacilityCurrencyCurrencyCode is a field in the CreditFacilityUsage table. It is an nvarchar data type with a maximum length of 128, and stores the code of the currency used in the associated credit facility."
},
"latest": {
"type": [
"boolean",
"null"
],
"description": "The Latest field in the CreditFacilityUsage table contains a binary value indicating whether or not the record is the most recent available credit facility usage. A value of 1 (true) indicates that this record is the latest known data; a value of 0 (false) indicates that another record exists which supersedes this data."
},
"referenceNumber": {
"maxLength": 64,
"type": [
"string",
"null"
],
"description": "ReferenceNumber is a data field of type nvarchar with a maximum length of 64 characters in the CreditFacilityUsage table. This field serves as an alphanumeric identifier for a specific credit facility usage referenced by the Credit Facility Usage table."
},
"creditFacilityTypeId": {
"maxLength": 64,
"type": [
"string",
"null"
],
"description": "CreditFacilityTypeId is an nvarchar field in the CreditFacilityUsage table with a maximum length of 64 characters. It is used to differentiate the type of credit facility being used by a customer, such as credit cards, loans, and mortgages."
},
"creditFacilityStateId": {
"maxLength": 64,
"type": [
"string",
"null"
],
"description": "The CreditFacilityStateId field of data type nvarchar in the CreditFacilityUsage table is used to store the unique identifier of the current state of a specific credit facility. It stores a maximum of 64 characters."
},
"accountReference": {
"type": [
"string",
"null"
],
"description": "AccountReference for CreditFacilityUsage is a field of type nvarchar which holds a reference to a specific account that utilizes a given Credit Facility."
},
"debtorName": {
"minLength": 1,
"type": "string",
"description": "DebtorName is an nvarchar field in the CreditFacilityUsage table that stores the name of the debtor associated with the associated CreditFacilityUsage record."
},
"debtorId": {
"type": "integer",
"description": "DebtorId is an integer data field in the CreditFacilityUsage table which identifies the unique debtor associated with the credit facility usage record.",
"format": "int32"
},
"debtorLogoImage": {
"type": [
"string",
"null"
],
"description": "DebtorLogoImage is an nvarchar field in CreditFacilityUsage table, which stores the logo of a debtor as an image in the database."
},
"lenderName": {
"minLength": 1,
"type": "string",
"description": "This field stores the name of the lender for the credit facility associated with each record in the CreditFacilityUsage table. The data type is nvarchar so that both regular text strings and Unicode strings of multiple languages may be stored."
},
"lenderLogoImage": {
"type": [
"string",
"null"
],
"description": "The LenderLogoImage field of the CreditFacilityUsage table stores the filename of the associated lender's logo image. This field is formatted as a nvarchar data type to store filenames with special characters."
}
},
"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-credit-facility-pkg-v-credit-facility-usage"
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.