Class: LockstepSdk::CashflowReportModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/cashflow_report_model.rb

Overview

Represents the cashflow report based on a timeframe

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ CashflowReportModel

Initialize the CashflowReportModel using the provided prototype



24
25
26
27
28
29
30
# File 'lib/lockstep_sdk/models/cashflow_report_model.rb', line 24

def initialize(params = {})
    @timeframe = params.dig(:timeframe)
    @payments_collected = params.dig(:payments_collected)
    @payments_collected_count = params.dig(:payments_collected_count)
    @invoices_billed = params.dig(:invoices_billed)
    @invoices_billed_count = params.dig(:invoices_billed_count)
end

Instance Attribute Details

#invoices_billedDouble

Returns Amount of invoices billed based in the timeframe.

Returns:

  • (Double)

    Amount of invoices billed based in the timeframe



39
40
41
# File 'lib/lockstep_sdk/models/cashflow_report_model.rb', line 39

def invoices_billed
  @invoices_billed
end

#invoices_billed_countInt32

Returns Number of invoices billed in the timeframe.

Returns:

  • (Int32)

    Number of invoices billed in the timeframe



41
42
43
# File 'lib/lockstep_sdk/models/cashflow_report_model.rb', line 41

def invoices_billed_count
  @invoices_billed_count
end

#payments_collectedDouble

Returns Amount of payments collected based in the timeframe.

Returns:

  • (Double)

    Amount of payments collected based in the timeframe



35
36
37
# File 'lib/lockstep_sdk/models/cashflow_report_model.rb', line 35

def payments_collected
  @payments_collected
end

#payments_collected_countInt32

Returns Number of payments collected based in the timeframe.

Returns:

  • (Int32)

    Number of payments collected based in the timeframe



37
38
39
# File 'lib/lockstep_sdk/models/cashflow_report_model.rb', line 37

def payments_collected_count
  @payments_collected_count
end

#timeframeInt32

Returns Timeframe in days the cashflow report is generated on.

Returns:

  • (Int32)

    Timeframe in days the cashflow report is generated on



33
34
35
# File 'lib/lockstep_sdk/models/cashflow_report_model.rb', line 33

def timeframe
  @timeframe
end