Package org.cyclos.entities.banking

Interface Summary

Interface	Description
HasCurrency	Marks an entity to have a currency
HasCurrencyAmount	Has both a currency and an amount
HasExpirationDate	Interface implemented by transactions that have an expiration date
IAccount	Interface for accounts
IUserAccount	Represents a user account, with all aspects it comprises
Trans	Common interface for transfers and transactions
TransactionWithInstallments<I extends Installment>	A transaction that has installments

Class Summary

Class	Description
Account	A generic account
AccountBalance	Holds the last known balance for an account
AccountBalanceLimitLog	Stores the history of an account's lower and upper credit limits
AccountFee	Taxes are charged over all accounts of a given type
AccountFeeLog	An account fee log records a charge execution
AccountFeeLogEvent	Contains information about events (logs) in an AccountFeeLog
AccountFeeTransfer	A transfer generated from an account fee charge
AccountLocator
AccountPaymentAmountLimitLog	Stores the history of an account's payment max amount, max amount per day, per week and per month limits.
AccountRates	rates stored on the account
AccountType	Represents an account type
AmountReservation	Contains Information about reserved amounts for a given account
ARateParameters	Parameters for A-rate
ArchivedEntityToRemoveFromIndex	An entity that was already archived and should be removed from the search index
AuthorizationLevel	An authorization level for an authorized transfer type
AuthorizationRole	A role for authorization of transfers
BalanceDisposalTransfer	A transfer generated when an account is being disposed with non-zero balance
BaseAccountLimitLog	Base class for account payment and balance limits.
BasePayment	Base class for payments and scheduled payment.
ChargebackTransfer	A transfer generated as a chargeback of another transfer
ClosedAccountBalance	Contains pre-calculated balance and reserved amount for an account at a given time point
Currency	An account type currency
CustomAmountReservation	A custom amount reservation, intended to be used via scripts (it can't be removed after a static analysis)
DirtyAccountBalance	Indicates that an account has a dirty balance starting on a given date
DRateCreationValueForTransferType	This entity stores the history of the dRateCreationValue field of TransferType.
DRateParameters	Parameters for D-rate
ExternalPayment	A payment to an external user
ExternalPaymentAmountReservation	Base class for amount reservations of external payments
GeneratedTransferType	Transfer type used by automatically generated transfers
ImportTransaction	Transaction created from an (system) import.
ImportTransfer	A transfer that has been imported
InitialCreditTransfer	A transfer generated when an account is created, granting the initial credit
Installment	An installment is an amount of money generated by a scheduled transaction, currently, ScheduledPayments and RecurringPayments.
InstallmentAmountReservation	An amount reservation related to an installment
InstallmentTransfer	A transfer generated by processing an installment
InternalTransaction	Base class for internal transactions, that is transactions between registers members (already in Cyclos)
OrderAmountReservation	An amount reservation through an web shop order
Payment	A direct payment
PaymentRequest	A payment request is sent from a user or system to another user or system.
PaymentTransfer	A transfer generated from a Payment processing
PaymentTransferType	Transfer type used by payments
PendingAuthorizationAmountReservation	Represents an amount reservation by a payment pending authorization
PendingUserAccount	Contains configurations for a user account yet to be created
QAccount	QAccount is a Querydsl query type for Account
QAccountBalance	QAccountBalance is a Querydsl query type for AccountBalance
QAccountBalanceLimitLog	QAccountBalanceLimitLog is a Querydsl query type for AccountBalanceLimitLog
QAccountFee	QAccountFee is a Querydsl query type for AccountFee
QAccountFeeLog	QAccountFeeLog is a Querydsl query type for AccountFeeLog
QAccountFeeLogEvent	QAccountFeeLogEvent is a Querydsl query type for AccountFeeLogEvent
QAccountFeeTransfer	QAccountFeeTransfer is a Querydsl query type for AccountFeeTransfer
QAccountPaymentAmountLimitLog	QAccountPaymentAmountLimitLog is a Querydsl query type for AccountPaymentAmountLimitLog
QAccountRates	QAccountRates is a Querydsl query type for AccountRates
QAccountType	QAccountType is a Querydsl query type for AccountType
QAmountReservation	QAmountReservation is a Querydsl query type for AmountReservation
QARateParameters	QARateParameters is a Querydsl query type for ARateParameters
QArchivedEntityToRemoveFromIndex	QArchivedEntityToRemoveFromIndex is a Querydsl query type for ArchivedEntityToRemoveFromIndex
QAuthorizationLevel	QAuthorizationLevel is a Querydsl query type for AuthorizationLevel
QAuthorizationRole	QAuthorizationRole is a Querydsl query type for AuthorizationRole
QBalanceDisposalTransfer	QBalanceDisposalTransfer is a Querydsl query type for BalanceDisposalTransfer
QBaseAccountLimitLog	QBaseAccountLimitLog is a Querydsl query type for BaseAccountLimitLog
QBasePayment	QBasePayment is a Querydsl query type for BasePayment
QChargebackTransfer	QChargebackTransfer is a Querydsl query type for ChargebackTransfer
QClosedAccountBalance	QClosedAccountBalance is a Querydsl query type for ClosedAccountBalance
QCurrency	QCurrency is a Querydsl query type for Currency
QCustomAmountReservation	QCustomAmountReservation is a Querydsl query type for CustomAmountReservation
QDirtyAccountBalance	QDirtyAccountBalance is a Querydsl query type for DirtyAccountBalance
QDRateCreationValueForTransferType	QDRateCreationValueForTransferType is a Querydsl query type for DRateCreationValueForTransferType
QDRateParameters	QDRateParameters is a Querydsl query type for DRateParameters
QExternalPayment	QExternalPayment is a Querydsl query type for ExternalPayment
QExternalPaymentAmountReservation	QExternalPaymentAmountReservation is a Querydsl query type for ExternalPaymentAmountReservation
QGeneratedTransferType	QGeneratedTransferType is a Querydsl query type for GeneratedTransferType
QImportTransaction	QImportTransaction is a Querydsl query type for ImportTransaction
QImportTransfer	QImportTransfer is a Querydsl query type for ImportTransfer
QInitialCreditTransfer	QInitialCreditTransfer is a Querydsl query type for InitialCreditTransfer
QInstallment	QInstallment is a Querydsl query type for Installment
QInstallmentAmountReservation	QInstallmentAmountReservation is a Querydsl query type for InstallmentAmountReservation
QInstallmentTransfer	QInstallmentTransfer is a Querydsl query type for InstallmentTransfer
QInternalTransaction	QInternalTransaction is a Querydsl query type for InternalTransaction
QOrderAmountReservation	QOrderAmountReservation is a Querydsl query type for OrderAmountReservation
QPayment	QPayment is a Querydsl query type for Payment
QPaymentRequest	QPaymentRequest is a Querydsl query type for PaymentRequest
QPaymentTransfer	QPaymentTransfer is a Querydsl query type for PaymentTransfer
QPaymentTransferType	QPaymentTransferType is a Querydsl query type for PaymentTransferType
QPendingAuthorizationAmountReservation	QPendingAuthorizationAmountReservation is a Querydsl query type for PendingAuthorizationAmountReservation
QPendingUserAccount	QPendingUserAccount is a Querydsl query type for PendingUserAccount
QRateParameters	QRateParameters is a Querydsl query type for RateParameters
QRecurringPayment	QRecurringPayment is a Querydsl query type for RecurringPayment
QRecurringPaymentOccurrence	QRecurringPaymentOccurrence is a Querydsl query type for RecurringPaymentOccurrence
QScheduledPayment	QScheduledPayment is a Querydsl query type for ScheduledPayment
QScheduledPaymentAmountReservation	QScheduledPaymentAmountReservation is a Querydsl query type for ScheduledPaymentAmountReservation
QScheduledPaymentInstallment	QScheduledPaymentInstallment is a Querydsl query type for ScheduledPaymentInstallment
QSystemAccount	QSystemAccount is a Querydsl query type for SystemAccount
QSystemAccountType	QSystemAccountType is a Querydsl query type for SystemAccountType
QTicket	QTicket is a Querydsl query type for Ticket
QTicketAmountReservation	QTicketAmountReservation is a Querydsl query type for TicketAmountReservation
QTimeBasedRateParameters	QTimeBasedRateParameters is a Querydsl query type for TimeBasedRateParameters
QTransaction	QTransaction is a Querydsl query type for Transaction
QTransactionAuthorization	QTransactionAuthorization is a Querydsl query type for TransactionAuthorization
QTransactionCustomField	QTransactionCustomField is a Querydsl query type for TransactionCustomField
QTransactionCustomFieldPossibleValue	QTransactionCustomFieldPossibleValue is a Querydsl query type for TransactionCustomFieldPossibleValue
QTransactionCustomFieldPossibleValueCategory	QTransactionCustomFieldPossibleValueCategory is a Querydsl query type for TransactionCustomFieldPossibleValueCategory
QTransactionCustomFieldValue	QTransactionCustomFieldValue is a Querydsl query type for TransactionCustomFieldValue
QTransfer	QTransfer is a Querydsl query type for Transfer
QTransferFee	QTransferFee is a Querydsl query type for TransferFee
QTransferFeeTransfer	QTransferFeeTransfer is a Querydsl query type for TransferFeeTransfer
QTransferFilter	QTransferFilter is a Querydsl query type for TransferFilter
QTransferStatus	QTransferStatus is a Querydsl query type for TransferStatus
QTransferStatusFlow	QTransferStatusFlow is a Querydsl query type for TransferStatusFlow
QTransferStatusLog	QTransferStatusLog is a Querydsl query type for TransferStatusLog
QTransferSummary	QTransferSummary is a Querydsl query type for TransferSummary
QTransferTransferStatusFlow	QTransferTransferStatusFlow is a Querydsl query type for TransferTransferStatusFlow
QTransferType	QTransferType is a Querydsl query type for TransferType
QUserAccount	QUserAccount is a Querydsl query type for UserAccount
QUserAccountFeeLog	QUserAccountFeeLog is a Querydsl query type for UserAccountFeeLog
QUserAccountType	QUserAccountType is a Querydsl query type for UserAccountType
QUserAccountVisibilitySettings	QUserAccountVisibilitySettings is a Querydsl query type for UserAccountVisibilitySettings
QVoucher	QVoucher is a Querydsl query type for Voucher
QVoucherAmountReservation	QVoucherAmountReservation is a Querydsl query type for VoucherAmountReservation
QVoucherCategory	QVoucherCategory is a Querydsl query type for VoucherCategory
QVoucherCategoryImage	QVoucherCategoryImage is a Querydsl query type for VoucherCategoryImage
QVoucherChargeback	QVoucherChargeback is a Querydsl query type for VoucherChargeback
QVoucherConfiguration	QVoucherConfiguration is a Querydsl query type for VoucherConfiguration
QVoucherCustomField	QVoucherCustomField is a Querydsl query type for VoucherCustomField
QVoucherCustomFieldPossibleValue	QVoucherCustomFieldPossibleValue is a Querydsl query type for VoucherCustomFieldPossibleValue
QVoucherCustomFieldPossibleValueCategory	QVoucherCustomFieldPossibleValueCategory is a Querydsl query type for VoucherCustomFieldPossibleValueCategory
QVoucherCustomFieldValue	QVoucherCustomFieldValue is a Querydsl query type for VoucherCustomFieldValue
QVoucherPack	QVoucherPack is a Querydsl query type for VoucherPack
QVoucherPackAmountReservation	QVoucherPackAmountReservation is a Querydsl query type for VoucherPackAmountReservation
QVoucherPackCustomFieldValue	QVoucherPackCustomFieldValue is a Querydsl query type for VoucherPackCustomFieldValue
QVoucherRedeem	QVoucherRedeem is a Querydsl query type for VoucherRedeem
QVoucherTemplate	QVoucherTemplate is a Querydsl query type for VoucherTemplate
QVoucherTemplateImage	QVoucherTemplateImage is a Querydsl query type for VoucherTemplateImage
QVoucherTopUp	QVoucherTopUp is a Querydsl query type for VoucherTopUp
QVoucherTransaction	QVoucherTransaction is a Querydsl query type for VoucherTransaction
QVoucherTransactionAmountReservation	QVoucherTransactionAmountReservation is a Querydsl query type for VoucherTransactionAmountReservation
QVoucherType	QVoucherType is a Querydsl query type for VoucherType
QVoucherTypeImage	QVoucherTypeImage is a Querydsl query type for VoucherTypeImage
QVoucherUnblockAmountReservation	QVoucherUnblockAmountReservation is a Querydsl query type for VoucherUnblockAmountReservation
RateParameters	Base class for all rate parameters on the currency
RecurringPayment	A recurring payment is processed periodically for a given number of times, or indefinitely (until canceled)
RecurringPaymentOccurrence	Represents an occurrence within a recurring payment
ScheduledPayment	A scheduled payment represents a group of scheduled transfers
ScheduledPaymentAmountReservation	Represents an amount reservation for a scheduled payment total amount (depends on PaymentTransferType.isReserveTotalAmountOnScheduledPayments())
ScheduledPaymentInstallment	Represents an installment within a scheduled payment
SystemAccount	A system account.
SystemAccountType	Type for system accounts
Ticket	It will generates a payment to a user after confirmation by the payer.
TicketAmountReservation	An amount reservation for a ticket approving / processing
TimeBasedRateParameters	Basic class for parameters of rates that can be initialized (A-rate, D-rate).
Transaction	A transaction is an abstract subject, which will determine that funds are transferred between accounts by one or more Transfers. WARNING: For every new reference to this entity it must be a corresponding delete in the archive application.
TransactionAuthorization	Represents an authorization for a given transaction
TransactionCustomField	A custom field for transactions
TransactionCustomFieldPossibleValue	Possible value for transaction custom fields
TransactionCustomFieldPossibleValueCategory	Possible value category for transaction fields
TransactionCustomFieldValue	Stores custom field values for Transactions
Transfer	Abstract class for a single, atomic transfer between accounts
TransferFee	A transaction fee is a fee charged over specific transactions
TransferFeeTransfer	A transfer generated from a transaction fee charge
TransferFilter	A transfer filter groups transfer types for reports or account history
TransferStatus	Mostly a conciliation status for a given transfer, but could be used more generally.
TransferStatusFlow	Represents a workflow of TransferStatus
TransferStatusLog	Logs a transfer status change
TransferSummary	Contais report data of invoices or transactions.
TransferTransferStatusFlow	Stores the current status of a transfer by flow
TransferType	Every transfer has a type, which may contain fees and other relevant data
UserAccount	An account owned by a user
UserAccountFeeLog	Stores information about a particular user account in an account fee charge
UserAccountType	Type for user accounts
UserAccountVisibilitySettings	The account visibility settings for an account owner
Voucher	A voucher represents a physical code that can be redeemed by a user to get a payment in his account
VoucherAmountReservation	An amount dereservation for a voucher
VoucherCategory	A voucher is used to visually group the voucher types
VoucherCategoryImage	An image set in a voucher category, to group voucher types
VoucherChargeback	Represents the chargeback of either a voucher redeem or top-up
VoucherConfiguration	A voucher configuration represents the system administration part of vouchers - which payment types are involved, as well as permissions for admins to manage voucher types from specific configurations
VoucherCustomField	A custom field for vouchers
VoucherCustomFieldPossibleValue	Possible value for voucher custom fields
VoucherCustomFieldPossibleValueCategory	Possible value category for voucher fields
VoucherCustomFieldValue	Stores custom field values for Vouchers
VoucherPack	A voucher pack represents a group of vouchers that share the same definitions
VoucherPackAmountReservation	An amount reservation through a voucher pack
VoucherPackCustomFieldValue	Stores custom field values for VoucherPacks
VoucherRedeem	Represents the redeeming of a voucher
VoucherTemplate	A voucher template defines a Thymeleaf template for the voucher to be printed to PDF
VoucherTemplateImage	Image used to store the contents of a voucher template image
VoucherTopUp	Represents a voucher top-up
VoucherTransaction	A voucher transaction, which either adds or removes amount from a voucher
VoucherTransactionAmountReservation	An amount reservation for a voucher transaction (either a redeem or top-up)
VoucherType	A voucher type defines how vouchers will be generated, and several restrictions over them.
VoucherTypeImage	An image set in a voucher type, to be used by vouchers
VoucherUnblockAmountReservation	An amount reservation for a voucher being unblocked

Enum Summary

Enum	Description
EntityTypeToRemoveFromIndex	Type of an entity to remove from index.