m8ty-dto - m8ty Data Transfer Objects/eu.m8ty.dtos.common

Package-level declarations

Types

enum ActiveEnumDto : Enum<ActiveEnumDto>

Status, if ACTIVE or INACTIVE. Values: ACTIVE,INACTIVE

data class AddressDto(var street: String? = null, var houseNumber: String? = null, var zip: String? = null, var city: String? = null, var state: String? = null, var countryISOCode: String? = null)

Address data.

AmountDto

data class AmountDto(var value: BigDecimal, var currency: CurrencyDto? = null)

Amount with value and currency.

AttachmentMetadataDto

data class AttachmentMetadataDto(var id: String, var mimetype: String, var name: String, var datePublishing: OffsetDateTime, var propertySize: Long? = null, var encoding: String? = null)

The file metadata holds the information about a file that may be a single document or a message attachment.

BankDto

data class BankDto(var id: String, var name: String, var clearingNumber: String, var groupName: String? = null, var bic: String? = null, var email: String? = null, var phone: String? = null, var website: String? = null, var address: AddressDto? = null, var logoPath: String? = null)

Details of a bank.

CashflowBalancePeriodEnumDto

enum CashflowBalancePeriodEnumDto : Enum<CashflowBalancePeriodEnumDto>

Period for which the cash flow balances are to be calculated. Values: MONTHLY,YEARLY

CurrencyDto

data class CurrencyDto(var isoCurrency: IsoCurrencyEnumDto, var symbol: String? = null)

Currency with ISO code and symbol.

DividendFrequencyEnumDto

enum DividendFrequencyEnumDto : Enum<DividendFrequencyEnumDto>

Frequency of dividends

ANNUALLY - Annual payout
TWICE_A_YEAR - Payout twice per year
THREE_TIMES_A_YEAR - Payout three times per year
QUARTERLY - Payout per quarter
TWICE_A_MONTH - Payout twice per month
MONTHLY - Payout monthly

Values: ANNUALLY,TWICE_A_YEAR,THREE_TIMES_A_YEAR,QUARTERLY,TWICE_A_MONTH,MONTHLY

ErrorMessageDto

data class ErrorMessageDto(var message: String, var field: String? = null)

Message, which contains more details about the error.

ErrorResponseDto

data class ErrorResponseDto(var endpoint: String, var code: String? = null, var messages: MutableList<ErrorMessageDto>? = null, var datetime: OffsetDateTime? = null, var traceId: String? = null)

Response if an error occurs. It contains information about the error, the date-time and the path for better support in error cases.

IsoCurrencyEnumDto

enum IsoCurrencyEnumDto : Enum<IsoCurrencyEnumDto>

ISO 4217 currency format. Values: AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BOV,BRL,BSD,BTN,BWP,BYN,BZD,CAD,CDF,CHE,CHF,CHN,CHW,CLF,CLP,CNY,COP,COU,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GGP,GHS,GIP,GMD,GNF,GOG,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,IMP,INR,IQD,IRR,ISK,JEP,JMD,JOD,JPY,KES,KGS,KHR,KID,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRU,MUR,MVR,MWK,MXN,MXV,MYR,MZN,NAD,NGN,NIO,NIS,NOK,NPR,NTD,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PRB,PYG,QAR,RMB,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SIG,SLL,SLS,SOS,SRD,SSP,STN,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TVD,TWD,TZS,UAH,UGX,USD,USN,UYI,UYU,UYW,UZS,VEF,VES,VND,VUV,WST,XAF,XAG,XAU,XBA,XBB,XBC,XBD,XCD,XDR,XOF,XPD,XPF,XPT,XSU,XTS,XUA,XXX,YER,ZAR,ZMW,ZWB,ZWL

PageDto

data class PageDto(var number: Int, var propertySize: Int, var numberOfElements: Int, var totalPages: Int, var totalElements: Long)

Object for paging in result lists.

ReadStatusDto

enum ReadStatusDto : Enum<ReadStatusDto>

Filter for read/unread documents. The default is ALL. Values: READ,UNREAD,ALL

StatusEnumDto

enum StatusEnumDto : Enum<StatusEnumDto>

Status of the request. The status can have the following states:

SUCCESSFUL - Request was processed successful
FAILED - Request failed without errors

Values: SUCCESSFUL,FAILED

StatusResponseDto

data class StatusResponseDto(var status: StatusEnumDto)

Status object.

TrendBalanceDto

data class TrendBalanceDto(var date: OffsetDateTime, var balance: AmountDto)

Trending balance of an account or credit card

TrendBalanceListDto

data class TrendBalanceListDto(var balances: MutableList<TrendBalanceDto>? = null)

List of trending balances of an account

TrendBalancePeriodEnumDto

enum TrendBalancePeriodEnumDto : Enum<TrendBalancePeriodEnumDto>

Period for which the trend balances are to be calculated. Values: SEVENDAYS,THIRTYDAYS,HALFYEAR,YEAR

WebFormStatusDto

enum WebFormStatusDto : Enum<WebFormStatusDto>

Web form status.

NOT_YET_OPENED - the web form was not yet opened by the end user
IN_PROGRESS - the web form has already been opened by the end user and is currently in progress
COMPLETED - the web form has been successfully completed (final status)
COMPLETED_WITH_ERROR - the web form has been completed with an error (final status)
EXPIRED - the web form has expired (final status)
ABORTED - the web form has been cancelled by the end user (final status)

Values: NOT_YET_OPENED,IN_PROGRESS,COMPLETED,COMPLETED_WITH_ERROR,EXPIRED,ABORTED