API Reference

Bookings

patch
https://app.financekey.com/OData/Bookings()

In FinanceKey a booking is a transaction that will trigger one or more movements of cash for an organisation. Each leg of a movement is referred to a cashflow and cashflow items. For example. Cash may be received from a Customer say, or paid to a vendor, or change hands inside the organisation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
double
required

The value of the booking and the cashflows that will be generated once the booking is submitted.

string
required
length between 1 and 32

The CashflowTagId field in the Booking table is of data type nvarchar with a maximum length of 32, and stores the identification code associated with a specific cashflow transaction. This code is used to identify the cashflow within the system and facilitate any required accounting changes.

date-time
required

The Value Date is a datetime2 field stored in the Booking table. It represents the date when a payment is made and accepted in a transaction on the books of a financial institution. It determines when the funds are made available to the payee or from whom they are debited.

double
required

Reporting Amount is the value of the booking in the 'Reporting' currency of the Company.

int32

The SourceItemId field in the Booking table is an integer data type that stores the unique identifier of the item that triggered the booking.

string | null

The SourceEntityId field on the Booking table stores a unique identifier for the entity that created the booking, such as a customer or a computer program. This field is an nvarchar data type, with a maximum length of 450. SourceEntityId is used to track the entity that created the booking, allowing further analysis of the booking patterns.

string | null

The reference used for payment tracking internally

double
required

The FXRate field in the Booking table stores the foreign exchange rate of the booking transaction, represented as a decimal.

string | null

The reference used for payment tracking externally by the recipient

date-time
required

DueDate of data type date: The DueDate of date field is used to store the date when a particular booking should be completed. This data type allows for the storage of date and time data up to the second.

int32

The Debtor Instruction. The account or entity that will be the source of the funds for the booking.

string
required
length between 1 and 3

CurrencyId is an nvarchar field which holds the currency ID for the booking in the Booking table. This field has a maximum length of 128 characters.

int32

The Creditor Instructionis the recipient of the funds for the cashflow.

string | null

Miscellaneous notes and information for the entry or record.

string | null

BookingTypeId is a nvarchar field within the Booking table with a maximum length of 128. It is used to track the type of booking for each record in the Booking table, such as 'Conference,' 'Business Meeting,' etc.

string | null

BookingText is an nvarchar field with a maximum length of 512 characters in the Booking table, which contains a description of a booking for reference. This field allows for detailed information about a booking, such as names, events and dates.

int32

BookingId is an auto incremented, unique positive integer field in the Booking table that serves as an identifier for each row stored in the Booking table. The data type is int and the value of the field starts from 1 and is incremented by one for each new booking created.

int32 | null
date-time | null
int32 | null
date-time | null
int32 | null
date-time | null
date-time | null

The SynchronisedOn field in the Booking table is of data type datetime2 and is used to track when a booking was synchronised with any external systems or platforms. This date and time value represents the most recent update made to the booking information, ensuring that all data is accurate and consistent with the latest version. This field is crucial in keeping all systems and platforms coordinated and up-to-date with the latest booking information, providing a seamless and efficient experience for both the user and any third-party systems involved in the booking process.

string | null

The PaymentReferenceNumber field in the Booking table is of data type nvarchar with a maximum length of 128 characters. This field is used to store a unique reference number that is associated with a specific payment transaction related to the booking. It is designed to provide a quick and easy way to track and identify a payment, making it a useful tool for record-keeping and reconciliation purposes. The use of nvarchar allows for a wide range of characters to be stored, making it suitable for various types of payment methods and reference number formats. With a maximum length of 128, this field ensures that all necessary information is captured accurately and completely.

string | null

The ExternalSourceId field in the Booking table is a data type of nvarchar with a maximum length of 256 characters. This field is used to store a unique identification code or number assigned by an external source, such as a booking platform or third-party system. This allows for easy tracking and integration of bookings from different sources into the Booking table. The max length of 256 ensures that the field can accommodate a wide range of identification codes from various sources.

string | null
Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

Updated over 1 year ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated over 1 year ago