Accounts

patch

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

Defines a financial account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

accountTypeId

string

required

length between 1 and 128

The type of account.

reference

string

required

length ≥ 1

The moniker or 'nickname' that is used for the account.

ownerId

int32

The owner/beneficiary/holder of the acccount.

comment

string | null

Miscellaneous notes and information for the entry or record.

currencyId

string

required

length between 1 and 128

The currency in which the account is maintained.

institiuteId

int32

The Business Partner institute that provides the account.

balanceStrategyId

string

required

length between 1 and 128

The strategy to be employed to manage the balance on the account.

fundingAccountId

int32 | null

The account from which funding should be taken

sweepAccountId

int32 | null

The account to which excess funds are moved.

viewSequence

int32

ViewSequence is an integer field in the Account table which determines the order in which accounts are displayed when querying this table. When sorting by ViewSequence, the accounts are displayed in ascending order, beginning with the lowest ViewSequence value.

latestAccountBalanceId

int32 | null

The LatestAccountBalanceId is a field within the Account table that represents the most recent account balance associated with the account. The data type of this field is integer, which means it stores numerical values. This field holds the unique identifier of the latest balance for each account, allowing for easy tracking and reference of current account status. This information is crucial for accurately monitoring account activity and making informed financial decisions.

withheldBalance

double

required

The wthheld balance is the amount that is 'held' by the bank. This amount is removed from the account 'book' balance to derive the 'available' balance. That is book balance - withheld balance = withheld balance.

subOwnerId

int32 | null

A second level sub owner of the account. This is used for reporting purposes only.

accountClosingDate

date-time | null

The AccountClosingDate field represents the date and time when an account is officially closed. This field utilizes the datetime2 data type, allowing for precise timestamps, including fractional seconds. It is used to track the closure of accounts for auditing purposes and historical reference, providing essential information for both account management and reporting.

accountOpeningDate

date-time | null

The AccountOpeningDate field represents the date and time when the account was opened. It uses the datetime2 data type to allow for a wide range of dates and sub-second precision, ensuring accurate tracking of account creation events. This field is essential for account management and reporting, providing valuable information for analyzing account activity over time.

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!