m8ty_client_bankdocuments

Bank Documents information service cover all the aspects of bank documents, attachments and categories.

Before you start

Check the documentation of the m8ty_client_bankdocuments library to get an idea about the available models and their properties.

import all needed libraries

 import 'package:dio/dio.dart';
 import 'package:m8ty_client_bankdocuments/m8ty_client_bankdocuments.dart';
 import 'package:m8ty_client_common/m8ty_client_common.dart';
 import 'package:built_collection/built_collection.dart';

How to perform different tasks

Here some examples how the dart client can be used

Search for unread payment documents

     final client = new M8tyClientBankdocuments().getBankDocumentsApi();

     final searchBankDocumentsRequest = SearchBankDocumentsRequestModel((b) => b
       ..customerId = "123"
       ..categoryType = BankDocumentCategoryTypeModel.PAYMENT_CATEGORY
       ..readStatus = SearchBankDocumentsRequestModelReadStatusEnum.UNREAD,
     );
     
     final Response<BankDocumentsPageModel> documents = await client.searchBankDocuments(
       searchBankDocumentsRequestModel: searchBankDocumentsRequestModel,
       page: 1,
       size: 100,
     );

Fetch document by id

final Response<BankDocumentModel> document = await client.getBankDocumentById(
  bankDocumentId: "1234",
);

Get list of all categories

  final Response<BuiltList<DocumentCategoryModel>> documents = await client.getAllDocumentCategories();

Get a position by id

    final client = M8tyClientBankdocuments().getCustodyPositionsApi();
    final Response<CustodyPositionModel> response = await client.fetchCustodyPositionById(
        bankdocumentsId: "123",
        bankdocumentsTransactionId: "789",
    );

Get specific attachment

 final client = M8tyClientBankdocuments().getAttachmentsApi();
 final Response<Uint8List> attachment = await client.getAttachmentById(
   documentId: "123",
   attachmentId: "4567",
 );
 
 File file = File("/temp/myfile");
 await file.writeAsBytes(attachment.data!);

Last modified: 30 September 2024