Institutes

post

https://app.financekey.com/OData/Institutes

An institute is an organisation that is known to FinanceKey.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

instituteId

int32

InstituteId is an integer data type field in the Institute table that uniquely identifies each institute in the table. It is typically auto-generated.

parentId

int32 | null

The ParentId field in the Institute table holds the id of the related Institute category, in cases where the Institute is a sub-institute of another Institute. The data type for this field is int.

code

string

required

length between 1 and 128

The Code field in the Institute table is a nvarchar of up to 128 characters and is used to store a code that uniquely identifies each institute.

name

string

required

length between 1 and 512

Name of data type nvarchar in the Institute table is a variable length string field that stores the name of the institute or educational institution. It can store up to 4000 characters, allowing for variations in spelling and international characters. It supports storing both plain text and non-alphanumeric symbols.

localName

string

required

length ≥ 1

LocalName is an nvarchar field in the Institute table. It stores the local name of a particular institute. It may be the same or different from the institute's official name.

comment

string | null

Miscellaneous notes and information for the entry or record.

logoStorageId

int32

LogoStorageId is an integer data type field in the table Institute. It stores the identifier of the logo associated with an institute in external storage.

accountClosingOffset

int32

Used to retrieve balances and transaction. Value is in hours and gets added to the time zone adjusted statement date. A value of -6 for example means that we retrieve previous day balances up until 6 am (when the account is in UTC timezone).

swiftBicId

string | null

instituteAddressId

int32 | 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!