invoice/lib/ui/reports/payment_tax_report.dart

// Package imports:
import 'package:built_collection/built_collection.dart';
import 'package:collection/collection.dart' show IterableNullableExtension;
import 'package:memoize/memoize.dart';

// Project imports:
import 'package:invoiceninja_flutter/constants.dart';
import 'package:invoiceninja_flutter/data/models/models.dart';
import 'package:invoiceninja_flutter/redux/reports/reports_state.dart';
import 'package:invoiceninja_flutter/redux/static/static_state.dart';
import 'package:invoiceninja_flutter/ui/reports/reports_screen.dart';
import 'package:invoiceninja_flutter/utils/enums.dart';

enum TaxRateReportFields {
  client,
  invoice,
  invoice_amount,
  invoice_date,
  payment_date,
  tax_name,
  tax_rate,
  tax_amount,
  tax_paid,
  payment_amount,
  currency,
  transaction_reference,
}

var memoizedPaymentTaxReport = memo9((
  UserCompanyEntity? userCompany,
  ReportsUIState reportsUIState,
  BuiltMap<String?, TaxRateEntity?> taxRateMap,
  BuiltMap<String, InvoiceEntity> invoiceMap,
  BuiltMap<String, InvoiceEntity> creditMap,
  BuiltMap<String, ClientEntity> clientMap,
  BuiltMap<String, PaymentEntity> paymentMap,
  BuiltMap<String, UserEntity> userMap,
  StaticState staticState,
) =>
    paymentTaxReport(userCompany!, reportsUIState, taxRateMap, invoiceMap,
        creditMap, clientMap, paymentMap, userMap, staticState));

ReportResult paymentTaxReport(
  UserCompanyEntity userCompany,
  ReportsUIState reportsUIState,
  BuiltMap<String?, TaxRateEntity?> taxRateMap,
  BuiltMap<String, InvoiceEntity> invoiceMap,
  BuiltMap<String, InvoiceEntity> creditMap,
  BuiltMap<String, ClientEntity> clientMap,
  BuiltMap<String, PaymentEntity> paymentMap,
  BuiltMap<String, UserEntity> userMap,
  StaticState staticState,
) {
  final List<List<ReportElement>> data = [];
  BuiltList<TaxRateReportFields> columns;

  final reportSettings = userCompany.settings.reportSettings;
  final taxRateReportSettings = reportSettings.containsKey(kReportPaymentTax)
      ? reportSettings[kReportPaymentTax]!
      : ReportSettingsEntity();

  final defaultColumns = [
    TaxRateReportFields.tax_name,
    TaxRateReportFields.tax_amount,
    TaxRateReportFields.tax_paid,
    TaxRateReportFields.invoice_amount,
    TaxRateReportFields.invoice_date,
    TaxRateReportFields.invoice,
    TaxRateReportFields.payment_date,
  ];

  if (taxRateReportSettings.columns.isNotEmpty) {
    columns = BuiltList(taxRateReportSettings.columns
        .map((e) => EnumUtils.fromString(TaxRateReportFields.values, e))
        .whereNotNull()
        .toList());
  } else {
    columns = BuiltList(defaultColumns);
  }

  for (var paymentId in paymentMap.keys) {
    final payment = paymentMap[paymentId] ?? PaymentEntity();

    if (!payment.isDeleted!) {
      final client = clientMap[payment.clientId]!;
      final precision =
          staticState.currencyMap[client.currencyId]?.precision ?? 2;

      for (final paymentable in payment.paymentables) {
        InvoiceEntity invoice;
        int multiplier = 1;
        if (paymentable.entityType == EntityType.invoice) {
          invoice = invoiceMap[paymentable.invoiceId] ?? InvoiceEntity();
        } else {
          invoice = creditMap[paymentable.creditId] ?? InvoiceEntity();
          multiplier = -1;
        }

        if (invoice.isSent && !invoice.isDeleted!) {
          final taxes = invoice.getTaxes(precision);

          for (final key in taxes.keys) {
            bool skip = false;

            final List<ReportElement> row = [];
            final String? taxName = taxes[key]!['name'];
            final double? taxRate = taxes[key]!['rate'];

            for (var column in columns) {
              dynamic value = '';

              switch (column) {
                case TaxRateReportFields.client:
                  value = client.displayName;
                  break;
                case TaxRateReportFields.invoice:
                  value = invoice.listDisplayName;
                  break;
                case TaxRateReportFields.invoice_date:
                  value = invoice.date;
                  break;
                case TaxRateReportFields.payment_date:
                  value = payment.date;
                  break;
                case TaxRateReportFields.invoice_amount:
                  value = invoice.amount *
                      paymentable.amount /
                      invoice.amount *
                      multiplier;
                  break;
                case TaxRateReportFields.tax_name:
                  value = taxName;
                  break;
                case TaxRateReportFields.tax_rate:
                  value = taxRate;
                  break;
                case TaxRateReportFields.tax_amount:
                  value = (taxes[key]!['amount'] ?? 0.0) *
                      paymentable.amount /
                      invoice.amount *
                      multiplier;
                  break;
                case TaxRateReportFields.tax_paid:
                  value = (taxes[key]!['paid'] ?? 0.0) *
                      paymentable.amount /
                      invoice.amount *
                      multiplier;
                  break;
                case TaxRateReportFields.payment_amount:
                  value = paymentable.amount * multiplier;
                  break;
                case TaxRateReportFields.currency:
                  value = staticState.currencyMap[client.currencyId]?.name ??
                      staticState.currencyMap[client.settings.currencyId]?.name;
                  break;
                case TaxRateReportFields.transaction_reference:
                  value = payment.transactionReference;
                  break;
              }

              if (!ReportResult.matchField(
                value: value,
                userCompany: userCompany,
                reportsUIState: reportsUIState,
                column: EnumUtils.parse(column),
              )!) {
                skip = true;
              }

              if (value.runtimeType == bool) {
                row.add(invoice.getReportBool(value: value));
              } else if (value.runtimeType == double ||
                  value.runtimeType == int) {
                row.add(invoice.getReportDouble(
                    value: value, currencyId: client.settings.currencyId));
              } else {
                row.add(invoice.getReportString(value: value));
              }
            }

            if (!skip) {
              data.add(row);
            }
          }
        }
      }
    }
  }

  final selectedColumns = columns.map((item) => EnumUtils.parse(item)).toList();
  data.sort((rowA, rowB) =>
      sortReportTableRows(rowA, rowB, taxRateReportSettings, selectedColumns)!);

  return ReportResult(
    allColumns:
        TaxRateReportFields.values.map((e) => EnumUtils.parse(e)).toList(),
    columns: columns.map((item) => EnumUtils.parse(item)).toList(),
    defaultColumns:
        defaultColumns.map((item) => EnumUtils.parse(item)).toList(),
    data: data,
  );
}