Class: LockstepSdk::ArHeaderInfoModel
- Inherits:
-
Object
- Object
- LockstepSdk::ArHeaderInfoModel
- Defined in:
- lib/lockstep_sdk/models/ar_header_info_model.rb
Overview
Aggregated Accounts Receivable information.
Instance Attribute Summary collapse
-
#amount_collected_past_thirty_days ⇒ Double
The total amount collected over the past thirty days.
-
#amount_due_past_thirty_days ⇒ Double
The amount outstanding on the invoices invoiced over the past thirty days.
-
#amount_invoiced_past_thirty_days ⇒ Double
The total amount invoiced over the past thirty days.
-
#base_currency_code ⇒ String
The base currency code of the group account.
-
#customers_invoiced_past_thirty_days ⇒ Int32
The number of customers invoiced over the the past thirty days.
-
#customers_paid_past_thirty_days ⇒ Int32
The number of customers who paid within the past thirty days.
-
#dso ⇒ Double
Daily sales outstanding.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#invoices_paid_past_thirty_days ⇒ Int32
The number of invoices paid over the past thirty days.
-
#invoices_past_thirty_days ⇒ Int32
The number of invoices invoiced over the past thirty days.
-
#percentage_of_total_ar ⇒ Double
Portion of Total AR that is Past due.
-
#percentage_of_total_ar90_days_past_due ⇒ Double
Portion of Total AR that is 90+ days Past due.
-
#report_date ⇒ Date
The date of the report.
-
#report_period ⇒ String
The date of the report.
-
#total_ar_amount ⇒ Double
The total accounts receivable amount.
-
#total_collected ⇒ Double
The total amount of collected payments.
-
#total_customers ⇒ Int32
The total number of customers.
-
#total_invoice_amount_current_year ⇒ Double
The total amount invoiced, due this year.
-
#total_invoice_amount_previous_year ⇒ Double
The total amount invoiced, due last year.
-
#total_invoiced_amount ⇒ Double
The total amount invoiced.
-
#total_invoices ⇒ Int32
The total number of invoices.
-
#total_invoices90_days_past_due ⇒ Int32
The number of past due invoices for the last 90 days.
-
#total_invoices_paid ⇒ Int32
The number of paid invoices.
-
#total_invoices_past_due ⇒ Int32
The number of past due invoices.
-
#total_past_due_amount ⇒ Double
The total amount past due.
-
#total_past_due_amount90_days ⇒ Double
The total past due for the past 90 days.
-
#total_payment_amount_current_year ⇒ Double
The total of all payments received this year.
-
#total_unapplied_payments ⇒ Double
The total number of unapplied payments.
-
#unapplied_amount_past_thirty_days ⇒ Double
The amount unapplied from the payments collected over the past thirty days.
Instance Method Summary collapse
-
#as_json(options = {}) ⇒ object
This object as a JSON key-value structure.
-
#initialize(params = {}) ⇒ ArHeaderInfoModel
constructor
Initialize the ArHeaderInfoModel using the provided prototype.
-
#to_json(*options) ⇒ String
This object converted to a JSON string.
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
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
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
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
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
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
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
123 124 125 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 123 def dso @dso end |
#group_key ⇒ Uuid
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
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
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
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
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
67 68 69 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 67 def report_date @report_date end |
#report_period ⇒ String
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
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
91 92 93 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 91 def total_collected @total_collected end |
#total_customers ⇒ Int32
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
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
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
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
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
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
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
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
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
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
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
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
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
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(={}) { '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
211 212 213 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 211 def to_json(*) "[#{as_json(*options).to_json(*options)}]" end |