Credit Facility Documents

patch

https://app.financekey.com/OData/v_CreditFacilityDocuments({key})

The CreditFacilityDocument table within the CreditFacility package contains information pertaining to credit facilities granted by a given financial institution. Each row contains metadata related to a single credit facility, including the identity of the lender and borrower, the product type, the amount of the facility, any restrictions, associated fees and rates, and the associated legal documentation that governs the facility agreement.

Path Params

key

string

required

Body Params

documentId

int32

DocumentId is an int data type field that is the Primary Key for the CreditFacilityDocument table. This field is used to uniquely identify each record in the table and can be used to join the CreditFacilityDocument table to other tables.

name

string

required

length ≥ 1

The Name of data type nvarchar field in the CreditFacilityDocument table is used to store user-entered text data of variable length up to a maximum of 4,000 characters long. This field can contain characters from all languages, including non-English characters.

entityId

string | null

The EntityId field of the CreditFacilityDocument table is used to store a unique identifier for the corresponding credit facility in the form of a string with a maximum length of 450 characters. The value stored in the EntityId field should be unique for each credit facility, and must be supplied when creating a new record.

creditFacilityId

int32 | null

The CreditFacilityId field in the CreditFacilityDocument table is an integer data type field that uniquely identifies each credit facility document in the system. It is used to associate a document with a single credit facility.

entityKeyValue

string | null

EntityKeyValue is an nvarchar field in the CreditFacilityDocument table which stores a unique identifier associated with the document in question. It is used to look up associated metadata and/or contents for the document.

documentTypeId

string

required

length between 1 and 450

DocumentTypeId is an nvarchar field of size 450 in the CreditFacilityDocument table that stores the unique identifier of the document type associated with a particular document.

fileName

string | null

The FileName field is a nvarchar data type within the CreditFacilityDocument table. It contains the full name and extension of a file, such as a .docx or .pdf, relevant to a particular credit facility document.

Response

200

Language

URL

Response

Click Try It! to start a request and see the response here!