Class: C2eCore::Drops::FinancialReportDrop

Inherits:

BaseDrop

• Object
• Liquid::Drop
• BaseDrop
• C2eCore::Drops::FinancialReportDrop

Includes:

Helpers::FinancialReportConversions

Defined in:

/build/app/mailers/c2e_core/drops/financial_report_drop.rb

Instance Method Summary

• #currency ⇒ Object
• #description ⇒ String

  • Description of financial report, which includes reportable type, reportable id and report sequence.

• #formatted_total_incomes ⇒ String

  • Sum of all incomes converted to financial report’s currency and formatted.

• #formatted_total_with_credit_funds_transfers ⇒ String

  • Formatted sum of all incomes and credit funds transfers values.

• #funds_transfers ⇒ FinancialReportCreditTransferDrop^?

  • Returns financial report for funds credit transfers as drop object, if any transfer is present.

• #grouped_incomes ⇒ Array[FinancialReportPaymentTypeDrop]

  • Array of all incomes statistics from financial report grouped by payment method.

• #grouped_total_with_credit_funds_transfers ⇒ Array[FinancialReportPaymentTypeDrop]

  • Array of statistics on the balance of credit funds transfers and incomes grouped by payment method.

• #id ⇒ Integer

  • ID of financial report in database.

• #initialize(financial_report) ⇒ FinancialReportDrop constructor

  A new instance of FinancialReportDrop.

• #report_datetime ⇒ DateTime

  • The date and time when the report was created.

• #report_datetime_from ⇒ DateTime^?

  • The date and time from which the report calculations begin.

• #report_sequence ⇒ Integer

  • Financial report sequence number.

• #reportable ⇒ CashBoxDrop, ...

  • Returns the object for which the report was generated (cash box or company branch) as a drop object.

• #terminal_financial_report ⇒ TerminalFinancialReportDrop^?

  • Returns the terminal financial report as a drop object, if it is present.

• #total_incomes ⇒ Float

  • Sum of all incomes converted into financial report’s currency.

• #total_orders_and_transfers_count ⇒ Integer

  • Number of orders and credit funds transfers.

• #total_orders_and_transfers_storno_count ⇒ Integer

  • Number of canceled orders and canceled credit funds transfers.

• #total_orders_count ⇒ Integer

  • The number of orders that belong to financial report.

• #total_storno_count ⇒ Integer

  • The number of canceled orders that belong to financial report.

• #total_vat_summarization ⇒ Array[FinancialReportVatDrop]

  • Array of all VAT statistic from financial report.

• #total_with_credit_funds_transfers ⇒ Float

  • Sum of all incomes and credit funds transfers values.

Constructor Details

#initialize(financial_report) ⇒ FinancialReportDrop

Returns a new instance of FinancialReportDrop.

Instance Method Details

#currency ⇒ Object

#description ⇒ String

Returns - Description of financial report, which includes reportable type, reportable id and report sequence. E.g.: “CompanyBranch ~ 10 ~ 1”.

Returns:

• (String) —

  • Description of financial report, which includes reportable type, reportable id and report

  sequence. E.g.: “CompanyBranch ~ 10 ~ 1”.

#formatted_total_incomes ⇒ String

Returns - Sum of all incomes converted to financial report’s currency and formatted. E.g.: "123,45 Kč".

Returns:

• (String) —

  • Sum of all incomes converted to financial report’s currency and formatted.

  E.g.: "123,45 Kč".

#formatted_total_with_credit_funds_transfers ⇒ String

Returns - Formatted sum of all incomes and credit funds transfers values. E.g.: "123,45 Kč".

Returns:

• (String) —

  • Formatted sum of all incomes and credit funds transfers values. E.g.: "123,45 Kč".

#funds_transfers ⇒ FinancialReportCreditTransferDrop^?

Returns - Returns financial report for funds credit transfers as drop object, if any transfer is present.

Returns:

• (FinancialReportCreditTransferDrop, nil) —

  • Returns financial report for funds credit transfers

  as drop object, if any transfer is present

#grouped_incomes ⇒ Array[FinancialReportPaymentTypeDrop]

Returns - Array of all incomes statistics from financial report grouped by payment method.

Returns:

• (Array[FinancialReportPaymentTypeDrop]) —

  • Array of all incomes statistics from financial report

  grouped by payment method

#grouped_total_with_credit_funds_transfers ⇒ Array[FinancialReportPaymentTypeDrop]

Returns - Array of statistics on the balance of credit funds transfers and incomes grouped by payment method.

Returns:

• (Array[FinancialReportPaymentTypeDrop]) —

  • Array of statistics on the balance of credit funds transfers

  and incomes grouped by payment method

#id ⇒ Integer

Returns - ID of financial report in database.

Returns:

• (Integer) —

  • ID of financial report in database.

#report_datetime ⇒ DateTime

Returns - The date and time when the report was created. E.g.: "2023-11-16T11:38:56+01:00".

Returns:

• (DateTime) —

  • The date and time when the report was created. E.g.: "2023-11-16T11:38:56+01:00"

#report_datetime_from ⇒ DateTime^?

Returns - The date and time from which the report calculations begin. E.g.: "2023-11-16T11:38:56+01:00".

Returns:

• (DateTime, nil) —

  • The date and time from which the report calculations begin.

  E.g.: "2023-11-16T11:38:56+01:00"

#report_sequence ⇒ Integer

Returns - Financial report sequence number. E.g.: 142.

Returns:

• (Integer) —

  • Financial report sequence number. E.g.: 142

#reportable ⇒ CashBoxDrop, ...

Returns - Returns the object for which the report was generated (cash box or company branch) as a drop object.

Returns:

• (CashBoxDrop, CompanyBranchDrop, nil) —

  • Returns the object for which the report was generated

  (cash box or company branch) as a drop object.

#terminal_financial_report ⇒ TerminalFinancialReportDrop^?

Returns - Returns the terminal financial report as a drop object, if it is present.

Returns:

• (TerminalFinancialReportDrop, nil) —

  • Returns the terminal financial report as a drop object,

  if it is present.

#total_incomes ⇒ Float

Returns - Sum of all incomes converted into financial report’s currency. E.g.: 78.

Returns:

• (Float) —

  • Sum of all incomes converted into financial report’s currency. E.g.: 78

#total_orders_and_transfers_count ⇒ Integer

Returns - Number of orders and credit funds transfers. E.g.: 42.

Returns:

• (Integer) —

  • Number of orders and credit funds transfers. E.g.: 42

#total_orders_and_transfers_storno_count ⇒ Integer

Returns - Number of canceled orders and canceled credit funds transfers. E.g.: 42.

Returns:

• (Integer) —

  • Number of canceled orders and canceled credit funds transfers. E.g.: 42

#total_orders_count ⇒ Integer

Returns - The number of orders that belong to financial report. E.g.: 42.

Returns:

• (Integer) —

  • The number of orders that belong to financial report. E.g.: 42

#total_storno_count ⇒ Integer

Returns - The number of canceled orders that belong to financial report. E.g.: 42.

Returns:

• (Integer) —

  • The number of canceled orders that belong to financial report. E.g.: 42

#total_vat_summarization ⇒ Array[FinancialReportVatDrop]

Returns - Array of all VAT statistic from financial report.

Returns:

• (Array[FinancialReportVatDrop]) —

  • Array of all VAT statistic from financial report

#total_with_credit_funds_transfers ⇒ Float

Returns - Sum of all incomes and credit funds transfers values. E.g.: 78.

Returns:

• (Float) —

  • Sum of all incomes and credit funds transfers values. E.g.: 78