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

Package-level declarations

Types

Link copied to clipboard
data class BankDocumentCategoryDto(var id: String? = null, var code: String? = null, var sortCode: String? = null, var type: BankDocumentCategoryTypeDto? = null, var name: String? = null, var visible: Boolean? = true, var dateCreated: OffsetDateTime? = null)

Category data

Link copied to clipboard
enum BankDocumentCategoryTypeDto : Enum<BankDocumentCategoryTypeDto>

Type of category. Values: BANK_DOCUMENT,PAYMENT_CATEGORY,SCREEN_CATEGORY,RULE_BASED_ACCESS_RIGHTS

Link copied to clipboard
data class BankDocumentDto(var id: String? = null, var category: BankDocumentCategoryDto? = null, var customerId: Any? = null, var datePublishing: OffsetDateTime? = null, var sourceObjectType: BankDocumentSourceObjectTypeDto? = null, var sourceObjectNumber: String? = null, var senderName: String? = null, var dateRead: OffsetDateTime? = null, var title: String? = null, var content: String? = null, var folder: FolderTypeDto? = null, var relevance: RelevanceTypeDto? = null, var deleted: Boolean? = null, var attachments: MutableList<AttachmentMetadataDto>? = null)

The bank document metadata

Link copied to clipboard
enum BankDocumentSourceObjectTypeDto : Enum<BankDocumentSourceObjectTypeDto>

Document source type as specified when creating document. Values: CUSTOMER,CONTRACT,ACCOUNT,CUSTODY_ACCOUNT,PORTFOLIO,MT5XX_DOCUMENT,TRANSACTION,ADVISOR

Link copied to clipboard
data class BankDocumentsPageDto(var bankDocuments: MutableList<BankDocumentDto>, var page: PageDto)

Paged result containing all requested Bank Documents of a user.

Link copied to clipboard
enum FolderTypeDto : Enum<FolderTypeDto>

Types of folders. Values: INBOX,ARCHIVE,WASTEBASKET,OUTBOX,DRAFT,CUSTOM

Link copied to clipboard
enum RelevanceTypeDto : Enum<RelevanceTypeDto>

Relevance of the document. Values: ATTENTION_REQUIRED,IMPORTANT,OTHERS

Link copied to clipboard
data class SearchBankDocumentsRequestDto(var customerId: Any? = null, var title: String? = null, var content: String? = null, var dateStart: OffsetDateTime? = null, var dateEnd: OffsetDateTime? = null, var categoryIds: MutableList<String>? = null, var categoryType: BankDocumentCategoryTypeDto? = null, var sourceObjectNumber: String? = null, var sourceObjectType: BankDocumentSourceObjectTypeDto? = null, var folder: FolderTypeDto? = null, var relevance: RelevanceTypeDto? = null, var readStatus: ReadStatusDto? = eu.m8ty.dtos.common.ReadStatusDto.ALL)

Search parameter for the Bank Document list. If the all fields are empty, all the user's Bank Documents will be returned.