Booking Import Instruction

post

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

BookingImportInstruction 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…

Body Params

instructionId

int32

The InstructionId field in the BookingImportInstruction table is an integer data type that identifies each instruction relating to a particular booking import. The InstructionId should be unique and will be automatically generated for each new booking instruction registered in the system.

beneficiaryName

string | null

The BeneficiaryName field of data type nvarchar with a maximum length of 128 in the BookingImportInstruction table is used to store the name of the beneficiary associated with the import instruction associated with a booking.

addressId

int32 | null

AddressId is an integer field in the BookingImportInstruction table which is used as a unique identifier to link a customer's address to their booking instruction.

accountNumber

string | null

The AccountNumber field in the BookingImportInstruction table is an nvarchar data type of maximum length 64, used to store the unique account-number for a booking generated by the user.

swiftBicId

string | null

SwiftBicId is an nvarchar field with a maximum length of 11 characters which stores the involved banking details of a particular booking import instruction in the BookingImportInstruction table.

agentNationalId

string | null

AgentNationalId is a field in the BookingImportInstruction table, which is used to store the national identification number of agents (Vonapp ID, Social Security Number, Passport Number, etc.) associated with a booking import instruction. This field is of data type nvarchar with a maximum length of 64 characters.

currencyId

string | null

CurrencyId is an nvarchar field with a maximum length of 128. It is a required field in the BookingImportInstruction table and stores the id of the currency associated with a booking instruction.

credit

boolean

The Credit field is a boolean field in the BookingImportInstruction table. It indicates whether a bookings import instruction was executed with or without a credit. The values of this field will be either 0 (false) or 1 (true).

debit

boolean

The field Debit of data type bit in the table BookingImportInstruction indicates whether the amount entered is a debit or not. it will be set to 1 if the amount is a debit and 0 if the amount is not a debit.

ibanCheckId

int32 | null

IbanCheckId is an int field in the BookingImportInstruction table that is used to store a unique identifier used to verify an International Bank Account Number (IBAN).

paymentMethodId

string | null

The PaymentMethodId field in the BookingImportInstruction table stores the unique identifier of the payment method used for an import instruction. It is a nvarchar data type with a maximum length of 64 characters.

comment

string | null

Miscellaneous notes and information for the entry or record.

bankAddressId

int32 | null

The BankAddressId field in the BookingImportInstruction table is an integer data type which stores a unique identifier for each bank address associated with a particular booking import instruction.

bankName

string | null

BankName is a nvarchar field of maximum length 128 in the BookingImportInstruction table, which stores the name of the bank of the corresponding imported booking instruction record.

externalSourceKey

string | null

ExternalSourceKey is an nvarchar field in the BookingImportInstruction table that defines a specific booking instruction from an outside source. This field contains up to 32 characters of information detailing the source, origin, reference number, and other data, which can be used to identify the exact instructions associated with a specific booking.

externalSourceNumber

string | null

ExternalSourceNumber is an nvarchar field with a maximum length of 32 located in the BookingImportInstruction table. It stores an alternative, external source identifier related to a booking which could be any combination of letters and numbers, such as a tracking number.

sourceEntityId

string | null

SourceEntityId is a nvarchar field that stores the unique identifier of the source entity in the BookingImportInstruction table. This field has a maximum length of 450 characters.

sourceItemId

int32 | null

SourceItemId is an integer data type field in the BookingImportInstruction table that represents the unique ID of the source item associated with this booking instruction. The source item is the source from which the booking instruction was created.

sourceAddress

string | null

SourceAddress is an nvarchar field in the BookingImportInstruction table that stores the street address of the source warehouse for a particular importing job. This field is limited to 4000 characters.

checksum

string | null

The Checksum field is a string of characters representing the sum of all data variables in the BookingImportInstruction table. It is stored as a varchar of up to 64 characters and its purpose is to provide a unique identifier to verify that the data is complete and correct.

instructionStateBadge

string | null

InstructionStateBadge is an nvarchar field of max length 4000 in the BookingImportInstruction table which stores the badge of the user who executed instructions related to the import booking process.

bankAddressAddressId

int32 | null

The BankAddressAddressId field in the BookingImportInstruction table is an integer data type which is used to uniquely identify each bank address associated with the import instruction. This field is important in order to reference the specific bank address associated with an import instruction.

sourceEntityEntityId

string

required

length between 1 and 450

The SourceEntityEntityId field in the BookingImportInstruction table contains entity identifiers from the source entity associated with bookings created from a bookings import instruction. The identifier is stored as an nvarchar value and has a maximum length of 450 characters.

accountCurrencyId

string | null

The AccountCurrencyId field is an nvarchar primary key field with a maximum length of 128 in the BookingImportInstruction table. It stores the currency in which the booking instructions are to be imported.

closingBalance

double | null

The ClosingBalance field in the BookingImportInstruction table is a decimal field that stores the final balance of a booking instruction after the specified transactions have been carried out.

instructionStateId

string | null

The InstructionStateId field stores an internal identifier for each state (e.g. submitted, accepted, rejected) of the BookingImportInstruction table. It is a nvarchar data type with a maximum length of 128.

ibanCheckStateBadge

string | null

This field stores an image badge representing the current state and compliance of an IBAN (International Bank Account Number). This badge will be used to display the current status of the IBAN on the BookingImportInstruction table. The field can accept any valid image URL up to 4000 characters in length.

ibanCheckStateId

string | null

IbanCheckStateId is a field of data type nvarchar in the Instruction table and has a maximum length of 128 characters. It stores the current state of the validation check for the given International Bank Account Number (IBAN). Possible values are ‘NotStarted’, ‘InProgress’ or ‘Completed’.

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!