Instructions

patch

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

Instruction table holds information related to the instructions on how to import a data set containing booking data. It contains records about the format, location, type, and source of the booking data being imported. The table is used to help automate the importing process for the organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

instructionId

int32

InstructionId is an integer data type that uniquely identifies each row in the Instruction table. It serves as a primary key for the table and ensures the integrity of the data.

beneficiaryName

string | null

The BeneficiaryName field in the Instruction table holds a 128 character long string that contains the name of the beneficiary specified in the instruction. It is stored as an nvarchar data type.

addressId

int32 | null

AddressId is an int data type in a database table named Instruction. It is used to store a unique address identifier for each record in the database. AddressId is a primary key of the Instruction table and can be used to relate to other tables within the database.

accountNumber

string | null

AccountNumber is a nvarchar field with a maximum length of 64 in the Instruction table. It stores unique customer account numbers in order to identify users, allowing them to have access to records they have permission to view.

swiftBicId

string | null

The SwiftBicId field in the Instruction table is an nvarchar field containing a Swift BIC code that is 11 characters long. This code is used to identify the instruction's sender and recipient to ensure accurate recipient identification and efficient international payments.

agentNationalId

string | null

AgentNationalId is a field in the Instruction table of data type nvarchar with a maximum length of 64 characters. It stores the national identification number of the agent related to the instructions listed in the table.

currencyId

string | null

The CurrencyId field in the Instruction table contains an alphanumeric identifier for the currency in which the instruction is being made. The maximum length of the field is 128 characters.

credit

boolean

The field Credit in the Instruction table stores a value of 0 or 1 that indicates whether an instruction has been credited to a corresponding account. A 0 indicates that no credit has been given, while a 1 indicates that credit has been given.

debit

boolean

The Debit field of the Instruction table is a bit data type which stores a boolean value to indicate whether the type of instruction is a debit or not. A value of 1 indicates that the instruction is a debit, while a value of 0 indicates that the instruction is not a debit.

paymentMethodId

string | null

The PaymentMethodId field in the Instruction table is a text field which stores the unique identifier of the payment method used to fulfill the instruction. The identifier is an nvarchar with a maximum length of 64 characters.

comment

string | null

Miscellaneous notes and information for the entry or record.

bankAddressId

int32 | null

BankAddressId is an int field used to identify the bank's address in the Instruction table. This field is populated when the corresponding instruction is linked to the bank's address.

bankName

string | null

The BankName field in the Instruction table holds a string of up to 128 characters that represents the name of a bank associated with the given instruction. This can be used to identify what bank should be given the instruction.

externalSourceKey

string | null

The ExternalSourceKey field is an nvarchar column in the Instruction table. It contains a unique identifier up to 32 characters long that represents the source of an instruction. This identifier is usually provided by an external system like a payment service provider.

externalSourceNumber

string | null

ExternalSourceNumber is an nvarchar field in the Instruction table. This field contains a unique 32-character alphanumeric identifier assigned by an external source related to the Instruction record.

sourceEntityId

string | null

SourceEntityId is an nvarchar field in the Instruction table with a maximum length of 450 characters. This field contains an ID that identifies the external source of the instruction.

sourceItemId

int32 | null

The internal id of the record that was the source of the Instruction that has been defined.

sourceAddress

string | null

SourceAddress is a nvarchar field with a maximum length of 4000 characters in the Instruction table. It stores the name and address of the origin of an instruction, if applicable.

approvedById

int32 | null

approvedOn

date-time | 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!