Class: LockstepSdk::ArHeaderInfoModel

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

Overview

Aggregated Accounts Receivable information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ ArHeaderInfoModel

Initialize the ArHeaderInfoModel using the provided prototype



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 24

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @report_period = params.dig(:report_period)
    @total_customers = params.dig(:total_customers)
    @total_invoices = params.dig(:total_invoices)
    @total_invoiced_amount = params.dig(:total_invoiced_amount)
    @total_unapplied_payments = params.dig(:total_unapplied_payments)
    @total_collected = params.dig(:total_collected)
    @total_ar_amount = params.dig(:total_ar_amount)
    @total_invoices_paid = params.dig(:total_invoices_paid)
    @total_invoices_past_due = params.dig(:total_invoices_past_due)
    @total_invoices90_days_past_due = params.dig(:total_invoices90_days_past_due)
    @total_past_due_amount = params.dig(:total_past_due_amount)
    @total_past_due_amount90_days = params.dig(:total_past_due_amount90_days)
    @percentage_of_total_ar = params.dig(:percentage_of_total_ar)
    @dso = params.dig(:dso)
    @total_invoice_amount_current_year = params.dig(:total_invoice_amount_current_year)
    @total_invoice_amount_previous_year = params.dig(:total_invoice_amount_previous_year)
    @total_payment_amount_current_year = params.dig(:total_payment_amount_current_year)
    @total_collected_past_thirty_days = params.dig(:total_collected_past_thirty_days)
    @total_invoices_paid_past_thirty_days = params.dig(:total_invoices_paid_past_thirty_days)
    @percentage_of_total_ar90_days_past_due = params.dig(:percentage_of_total_ar90_days_past_due)
end

Instance Attribute Details

#dsoDouble

Returns Daily sales outstanding.

Returns:

  • (Double)

    Daily sales outstanding.



77
78
79
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 77

def dso
  @dso
end

#group_keyUuid

Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).

Returns:

  • (Uuid)

    The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).



49
50
51
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 49

def group_key
  @group_key
end

#percentage_of_total_arDouble

Returns Portion of Total AR that is Past due.

Returns:

  • (Double)

    Portion of Total AR that is Past due.



75
76
77
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 75

def percentage_of_total_ar
  @percentage_of_total_ar
end

#percentage_of_total_ar90_days_past_dueDouble

Returns Portion of Total AR that is 90+ days Past due.

Returns:

  • (Double)

    Portion of Total AR that is 90+ days Past due.



89
90
91
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 89

def percentage_of_total_ar90_days_past_due
  @percentage_of_total_ar90_days_past_due
end

#report_periodDate

Returns The date of the report.

Returns:

  • (Date)

    The date of the report



51
52
53
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 51

def report_period
  @report_period
end

#total_ar_amountDouble

Returns The total accounts receivable amount.

Returns:

  • (Double)

    The total accounts receivable amount.



63
64
65
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 63

def total_ar_amount
  @total_ar_amount
end

#total_collectedDouble

Returns The total amount of collected payments.

Returns:

  • (Double)

    The total amount of collected payments.



61
62
63
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 61

def total_collected
  @total_collected
end

#total_collected_past_thirty_daysInt32

Returns The total amount of payments received in the last 30 days.

Returns:

  • (Int32)

    The total amount of payments received in the last 30 days



85
86
87
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 85

def total_collected_past_thirty_days
  @total_collected_past_thirty_days
end

#total_customersInt32

Returns The total number of customers.

Returns:

  • (Int32)

    The total number of customers.



53
54
55
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 53

def total_customers
  @total_customers
end

#total_invoice_amount_current_yearDouble

Returns The total amount invoiced, due this year.

Returns:

  • (Double)

    The total amount invoiced, due this year.



79
80
81
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 79

def total_invoice_amount_current_year
  @total_invoice_amount_current_year
end

#total_invoice_amount_previous_yearDouble

Returns The total amount invoiced, due last year.

Returns:

  • (Double)

    The total amount invoiced, due last year.



81
82
83
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 81

def total_invoice_amount_previous_year
  @total_invoice_amount_previous_year
end

#total_invoiced_amountDouble

Returns The total amount invoiced.

Returns:

  • (Double)

    The total amount invoiced.



57
58
59
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 57

def total_invoiced_amount
  @total_invoiced_amount
end

#total_invoicesInt32

Returns The total number of invoices.

Returns:

  • (Int32)

    The total number of invoices.



55
56
57
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 55

def total_invoices
  @total_invoices
end

#total_invoices90_days_past_dueInt32

Returns The number of past due invoices for the last 90 days.

Returns:

  • (Int32)

    The number of past due invoices for the last 90 days.



69
70
71
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 69

def total_invoices90_days_past_due
  @total_invoices90_days_past_due
end

#total_invoices_paidInt32

Returns The number of paid invoices.

Returns:

  • (Int32)

    The number of paid invoices.



65
66
67
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 65

def total_invoices_paid
  @total_invoices_paid
end

#total_invoices_paid_past_thirty_daysInt32

Returns The total amount of Invoices paid in the last 30 days.

Returns:

  • (Int32)

    The total amount of Invoices paid in the last 30 days



87
88
89
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 87

def total_invoices_paid_past_thirty_days
  @total_invoices_paid_past_thirty_days
end

#total_invoices_past_dueInt32

Returns The number of past due invoices.

Returns:

  • (Int32)

    The number of past due invoices.



67
68
69
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 67

def total_invoices_past_due
  @total_invoices_past_due
end

#total_past_due_amountDouble

Returns The total amount past due.

Returns:

  • (Double)

    The total amount past due.



71
72
73
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 71

def total_past_due_amount
  @total_past_due_amount
end

#total_past_due_amount90_daysDouble

Returns The total past due for the past 90 days.

Returns:

  • (Double)

    The total past due for the past 90 days.



73
74
75
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 73

def total_past_due_amount90_days
  @total_past_due_amount90_days
end

#total_payment_amount_current_yearDouble

Returns The total of all payments received this year.

Returns:

  • (Double)

    The total of all payments received this year.



83
84
85
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 83

def total_payment_amount_current_year
  @total_payment_amount_current_year
end

#total_unapplied_paymentsDouble

Returns The total number of unapplied payments.

Returns:

  • (Double)

    The total number of unapplied payments.



59
60
61
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 59

def total_unapplied_payments
  @total_unapplied_payments
end