Credit Facilities

patch

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

Defines the facilities a client has agreed with counterparties for credit.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

referenceNumber

string

required

length between 1 and 64

A Unique reference number for the credit facility

creditFacilityTypeId

string

required

length between 1 and 64

The type of credit facility

creditFacilityStateId

string

required

length between 1 and 64

The current state of the Credit Facility

debtorId

int32

The legal entity that will be the holder of the credit facility. For overdrafts, this is the beneficiary of the account.

lenderId

int32

The provider of the credit facility. For overdrafts, this will be the institute that provides the bank account.

currencyId

string

required

length between 1 and 128

The currency of the credit facility

accountId

int32 | null

The AccountId field in the CreditFacility table is an integer data type used to uniquely identify each account in the facility. This field is a required field and must be a unique integer that remains constant for each associated record.

amount

double

required

The amount of the credit facility

effectiveDate

date-time | null

The EffectiveDate field in the CreditFacility table includes the date when the credit facility is entered into by the customer and is effective for the duration of the agreement. It is a datetime2 data type and stores both the date and time data values.

comment

string | null

Miscellaneous notes and information for the entry or record.

includeCreditBalances

boolean

When the credit facility is applied to a cash pool or bank cash pool, and this box is checked, credit balances will be taken into account and result in a net reduction of the facility usage. Default behaviour is for credit facilities to only consider overdrawn balances for facility usage.

rate

double | null

referenceRateId

string | null

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

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