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



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 25

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @base_currency_code = params.dig(:base_currency_code)
    @report_date = params.dig(:report_date)
    @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)
    @percentage_of_total_ar90_days_past_due = params.dig(:percentage_of_total_ar90_days_past_due)
    @customers_paid_past_thirty_days = params.dig(:customers_paid_past_thirty_days)
    @amount_collected_past_thirty_days = params.dig(:amount_collected_past_thirty_days)
    @unapplied_amount_past_thirty_days = params.dig(:unapplied_amount_past_thirty_days)
    @invoices_paid_past_thirty_days = params.dig(:invoices_paid_past_thirty_days)
    @customers_invoiced_past_thirty_days = params.dig(:customers_invoiced_past_thirty_days)
    @amount_invoiced_past_thirty_days = params.dig(:amount_invoiced_past_thirty_days)
    @amount_due_past_thirty_days = params.dig(:amount_due_past_thirty_days)
    @invoices_past_thirty_days = params.dig(:invoices_past_thirty_days)
end

Instance Attribute Details

#amount_collected_past_thirty_days ⇒ Double

Returns The total amount collected over the past thirty days.

Returns:

  • (Double) —

    The total amount collected over the past thirty days.



147
148
149
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 147

def amount_collected_past_thirty_days
  @amount_collected_past_thirty_days
end

#amount_due_past_thirty_days ⇒ Double

Returns The amount outstanding on the invoices invoiced over the past thirty days.

Returns:

  • (Double) —

    The amount outstanding on the invoices invoiced over the past thirty days.



167
168
169
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 167

def amount_due_past_thirty_days
  @amount_due_past_thirty_days
end

#amount_invoiced_past_thirty_days ⇒ Double

Returns The total amount invoiced over the past thirty days.

Returns:

  • (Double) —

    The total amount invoiced over the past thirty days.



163
164
165
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 163

def amount_invoiced_past_thirty_days
  @amount_invoiced_past_thirty_days
end

#base_currency_code ⇒ String

Returns The base currency code of the group account.

Returns:

  • (String) —

    The base currency code of the group account



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

def base_currency_code
  @base_currency_code
end

#customers_invoiced_past_thirty_days ⇒ Int32

Returns The number of customers invoiced over the the past thirty days.

Returns:

  • (Int32) —

    The number of customers invoiced over the the past thirty days.



159
160
161
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 159

def customers_invoiced_past_thirty_days
  @customers_invoiced_past_thirty_days
end

#customers_paid_past_thirty_days ⇒ Int32

Returns The number of customers who paid within the past thirty days.

Returns:

  • (Int32) —

    The number of customers who paid within the past thirty days.



143
144
145
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 143

def customers_paid_past_thirty_days
  @customers_paid_past_thirty_days
end

#dso ⇒ Double

Returns Daily sales outstanding.

Returns:

  • (Double) —

    Daily sales outstanding.



123
124
125
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 123

def dso
  @dso
end

#group_key ⇒ Uuid

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).



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

def group_key
  @group_key
end

#invoices_paid_past_thirty_days ⇒ Int32

Returns The number of invoices paid over the past thirty days.

Returns:

  • (Int32) —

    The number of invoices paid over the past thirty days.



155
156
157
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 155

def invoices_paid_past_thirty_days
  @invoices_paid_past_thirty_days
end

#invoices_past_thirty_days ⇒ Int32

Returns The number of invoices invoiced over the past thirty days.

Returns:

  • (Int32) —

    The number of invoices invoiced over the past thirty days.



171
172
173
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 171

def invoices_past_thirty_days
  @invoices_past_thirty_days
end

#percentage_of_total_ar ⇒ Double

Returns Portion of Total AR that is Past due.

Returns:

  • (Double) —

    Portion of Total AR that is Past due.



119
120
121
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 119

def percentage_of_total_ar
  @percentage_of_total_ar
end

#percentage_of_total_ar90_days_past_due ⇒ Double

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

Returns:

  • (Double) —

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



139
140
141
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 139

def percentage_of_total_ar90_days_past_due
  @percentage_of_total_ar90_days_past_due
end

#report_date ⇒ Date

Returns The date of the report.

Returns:

  • (Date) —

    The date of the report



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

def report_date
  @report_date
end

#report_period ⇒ String

Returns The date of the report.

Returns:

  • (String) —

    The date of the report



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

def report_period
  @report_period
end

#total_ar_amount ⇒ Double

Returns The total accounts receivable amount.

Returns:

  • (Double) —

    The total accounts receivable amount.



95
96
97
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 95

def total_ar_amount
  @total_ar_amount
end

#total_collected ⇒ Double

Returns The total amount of collected payments.

Returns:

  • (Double) —

    The total amount of collected payments.



91
92
93
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 91

def total_collected
  @total_collected
end

#total_customers ⇒ Int32

Returns The total number of customers.

Returns:

  • (Int32) —

    The total number of customers.



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

def total_customers
  @total_customers
end

#total_invoice_amount_current_year ⇒ Double

Returns The total amount invoiced, due this year.

Returns:

  • (Double) —

    The total amount invoiced, due this year.



127
128
129
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 127

def total_invoice_amount_current_year
  @total_invoice_amount_current_year
end

#total_invoice_amount_previous_year ⇒ Double

Returns The total amount invoiced, due last year.

Returns:

  • (Double) —

    The total amount invoiced, due last year.



131
132
133
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 131

def total_invoice_amount_previous_year
  @total_invoice_amount_previous_year
end

#total_invoiced_amount ⇒ Double

Returns The total amount invoiced.

Returns:

  • (Double) —

    The total amount invoiced.



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

def total_invoiced_amount
  @total_invoiced_amount
end

#total_invoices ⇒ Int32

Returns The total number of invoices.

Returns:

  • (Int32) —

    The total number of invoices.



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

def total_invoices
  @total_invoices
end

#total_invoices90_days_past_due ⇒ Int32

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.



107
108
109
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 107

def total_invoices90_days_past_due
  @total_invoices90_days_past_due
end

#total_invoices_paid ⇒ Int32

Returns The number of paid invoices.

Returns:

  • (Int32) —

    The number of paid invoices.



99
100
101
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 99

def total_invoices_paid
  @total_invoices_paid
end

#total_invoices_past_due ⇒ Int32

Returns The number of past due invoices.

Returns:

  • (Int32) —

    The number of past due invoices.



103
104
105
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 103

def total_invoices_past_due
  @total_invoices_past_due
end

#total_past_due_amount ⇒ Double

Returns The total amount past due.

Returns:

  • (Double) —

    The total amount past due.



111
112
113
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 111

def total_past_due_amount
  @total_past_due_amount
end

#total_past_due_amount90_days ⇒ Double

Returns The total past due for the past 90 days.

Returns:

  • (Double) —

    The total past due for the past 90 days.



115
116
117
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 115

def total_past_due_amount90_days
  @total_past_due_amount90_days
end

#total_payment_amount_current_year ⇒ Double

Returns The total of all payments received this year.

Returns:

  • (Double) —

    The total of all payments received this year.



135
136
137
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 135

def total_payment_amount_current_year
  @total_payment_amount_current_year
end

#total_unapplied_payments ⇒ Double

Returns The total number of unapplied payments.

Returns:

  • (Double) —

    The total number of unapplied payments.



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

def total_unapplied_payments
  @total_unapplied_payments
end

#unapplied_amount_past_thirty_days ⇒ Double

Returns The amount unapplied from the payments collected over the past thirty days.

Returns:

  • (Double) —

    The amount unapplied from the payments collected over the past thirty days.



151
152
153
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 151

def unapplied_amount_past_thirty_days
  @unapplied_amount_past_thirty_days
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 175

def as_json(options={})
    {
        'groupKey' => @group_key,
        'baseCurrencyCode' => @base_currency_code,
        'reportDate' => @report_date,
        'reportPeriod' => @report_period,
        'totalCustomers' => @total_customers,
        'totalInvoices' => @total_invoices,
        'totalInvoicedAmount' => @total_invoiced_amount,
        'totalUnappliedPayments' => @total_unapplied_payments,
        'totalCollected' => @total_collected,
        'totalArAmount' => @total_ar_amount,
        'totalInvoicesPaid' => @total_invoices_paid,
        'totalInvoicesPastDue' => @total_invoices_past_due,
        'totalInvoices90DaysPastDue' => @total_invoices90_days_past_due,
        'totalPastDueAmount' => @total_past_due_amount,
        'totalPastDueAmount90Days' => @total_past_due_amount90_days,
        'percentageOfTotalAr' => @percentage_of_total_ar,
        'dso' => @dso,
        'totalInvoiceAmountCurrentYear' => @total_invoice_amount_current_year,
        'totalInvoiceAmountPreviousYear' => @total_invoice_amount_previous_year,
        'totalPaymentAmountCurrentYear' => @total_payment_amount_current_year,
        'percentageOfTotalAr90DaysPastDue' => @percentage_of_total_ar90_days_past_due,
        'customersPaidPastThirtyDays' => @customers_paid_past_thirty_days,
        'amountCollectedPastThirtyDays' => @amount_collected_past_thirty_days,
        'unappliedAmountPastThirtyDays' => @unapplied_amount_past_thirty_days,
        'invoicesPaidPastThirtyDays' => @invoices_paid_past_thirty_days,
        'customersInvoicedPastThirtyDays' => @customers_invoiced_past_thirty_days,
        'amountInvoicedPastThirtyDays' => @amount_invoiced_past_thirty_days,
        'amountDuePastThirtyDays' => @amount_due_past_thirty_days,
        'invoicesPastThirtyDays' => @invoices_past_thirty_days,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



211
212
213
 
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 211

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end