Booking Cycle Payment

patch

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

The Payment table in the Payment package is a comprehensive database that stores records of all financial transactions made within the system. It is designed to track the details of payments made by customers or clients, including date, amount, payment method, and invoice number. This table also contains information about payment status, such as pending, completed, or cancelled. The Payment table provides a clear overview of all payments made, making it easier for businesses to manage their financial records and reconcile accounts. Additionally, it allows for the efficient tracking and reporting of payment activities, providing valuable insights into a company's cash flow. Complete with well-organized columns and rows, the Payment table is a critical component for any business looking to maintain accurate and organized financial data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

paymentId

int32

The PaymentId field in the BookingCyclePayment table is of data type int and stores the unique identifier for each payment associated with a booking cycle. This id will be used to reference the payment in other related tables.

debtorBeneficiaryName

string | null

The DebtorBeneficiaryName field is an nvarchar data type with a maximum length of 128 characters in the BookingCyclePayment table. This field stores the name of the individual or entity named as a debtor in a booking cycle payment.

bookingCycleId

int32

The BookingCycleId field in the BookingCyclePayment table is a unique integer identifier for each booking cycle payment. It is used to link the payment to the corresponding booking cycle that produced it.

creditorBeneficiaryName

string | null

The CreditorBeneficiaryName field in the BookingCyclePayment table is a nvarchar data type with a maximum length of 128. It stores the name of the creditor or party that is receiving the payment.

valueDate

date-time

required

ValueDate is a datetime2 data type field in the BookingCyclePayment table which stores the date when funds are deposited or removed from a bank account and reflected in a customer’s balance. It is used by banks and other payment processors and providers to track the movement of funds.

amount

double

required

The Amount field in the BookingCyclePayment table stores a numerical value in the form of a decimal number representing the monetary amount associated with a particular booking cycle payment.

currencyId

string | null

CurrencyId is a nvarchar field with a maximum length of 128 in the BookingCyclePayment table that stores the ID of the currency used to conduct a transaction during a booking cycle.

remittanceInformation

string | null

RemittanceInformation is a field in the BookingCyclePayment table storing information with regards to the remittance or payment such as the recipient or method of payment. The field data type is nvarchar, which allows for the storage of up to 255 characters of text-based data.

chargeBearerId

string | null

ChargeBearerId is an nvarchar field in the BookingCyclePayment table that stores an identification string of up to 64 characters. The ChargeBearerId is assigned to a booking cycle payment when it is created, and can be used to uniquely identify it.

statusId

string | null

The StatusId field in the BookingCyclePayment table is an nvarchar data type with a maximum length of 64. It is used to store the status associated with each payment of a booking cycle, such as 'Processed' or 'Error'.

reference

string | null

The Reference field in the BookingCyclePayment table is an nvarchar data type field allowing a maximum of 128 characters. Its purpose is to store an alphanumeric reference code that associates the payment in this table with a booking cycle. The booking cycle is a record in the BookingCycle table that relates to the actual payment itself. The reference code is unique in both the BookingCyclePayment and BookingCycle tables.

cashflowItemId

int32

CashflowItemId is an int data type field in the BookingCyclePayment table representing the unique identifier for payment in the cycle payment model used for bookings.

debtorInstructionId

int32

DebtorInstructionId is an int field that is used to store the unique identifier assigned to a particular debtor instruction within a BookingCyclePayment. It is used to easily locate and view specific transactions within the table.

creditorInstructionId

int32

The field CreditorInstructionId of data type int in the table BookingCyclePayment stores the unique identifier of the external source instruction, associated with the upcoming payment due in the payment/booking cycle.

paymentMessage

string | null

The PaymentMessage field of type nvarchar in the BookingCyclePayment table stores a brief textual description of a payment made as part of a booking cycle.

paymentSetId

int32 | null

The PaymentSetId field within the BookingCyclePayment table is an integer type field which stores a unique identifier for a set of payment details that are associated with a particular booking cycle.

comment

string | null

Miscellaneous notes and information for the entry or record.

bankReference

string | null

BankReference is an NVARCHAR(64) field in the BookingCyclePayment table. This field represents a unique identifier to reference a specific bank account linked to this payment cycle.

debtorAccountReference

string | null

The DebtorAccountReference field in the Payment table is an nvarchar data type, which stores a unique reference number associated with the debtors account. This allows for the quick and easy identification of payments made to or received from a given debtor.

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!