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
-
#dso ⇒ Double
Daily sales outstanding.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#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_period ⇒ Date
The date of the report.
-
#total_ar_amount ⇒ Double
The total accounts receivable amount.
-
#total_collected ⇒ Double
The total amount of collected payments.
-
#total_collected_past_thirty_days ⇒ Int32
The total amount of payments received in the last 30 days.
-
#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_paid_past_thirty_days ⇒ Int32
The total amount of Invoices paid in the last 30 days.
-
#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.
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
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 26 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
#dso ⇒ Double
Returns Daily sales outstanding.
79 80 81 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 79 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).
51 52 53 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 51 def group_key @group_key end |
#percentage_of_total_ar ⇒ Double
Returns Portion of Total AR that is Past due.
77 78 79 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 77 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.
91 92 93 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 91 def percentage_of_total_ar90_days_past_due @percentage_of_total_ar90_days_past_due end |
#report_period ⇒ Date
Returns The date of the report.
53 54 55 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 53 def report_period @report_period end |
#total_ar_amount ⇒ Double
Returns The total accounts receivable amount.
65 66 67 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 65 def total_ar_amount @total_ar_amount end |
#total_collected ⇒ Double
Returns The total amount of collected payments.
63 64 65 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 63 def total_collected @total_collected end |
#total_collected_past_thirty_days ⇒ Int32
Returns The total amount of payments received in the last 30 days.
87 88 89 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 87 def total_collected_past_thirty_days @total_collected_past_thirty_days end |
#total_customers ⇒ Int32
Returns The total number of customers.
55 56 57 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 55 def total_customers @total_customers end |
#total_invoice_amount_current_year ⇒ Double
Returns The total amount invoiced, due this year.
81 82 83 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 81 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.
83 84 85 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 83 def total_invoice_amount_previous_year @total_invoice_amount_previous_year end |
#total_invoiced_amount ⇒ Double
Returns The total amount invoiced.
59 60 61 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 59 def total_invoiced_amount @total_invoiced_amount end |
#total_invoices ⇒ Int32
Returns The total number of invoices.
57 58 59 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 57 def total_invoices @total_invoices end |
#total_invoices90_days_past_due ⇒ Int32
Returns The number of past due invoices for the last 90 days.
71 72 73 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 71 def total_invoices90_days_past_due @total_invoices90_days_past_due end |
#total_invoices_paid ⇒ Int32
Returns The number of paid invoices.
67 68 69 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 67 def total_invoices_paid @total_invoices_paid end |
#total_invoices_paid_past_thirty_days ⇒ Int32
Returns The total amount of Invoices paid in the last 30 days.
89 90 91 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 89 def total_invoices_paid_past_thirty_days @total_invoices_paid_past_thirty_days end |
#total_invoices_past_due ⇒ Int32
Returns The number of past due invoices.
69 70 71 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 69 def total_invoices_past_due @total_invoices_past_due end |
#total_past_due_amount ⇒ Double
Returns The total amount past due.
73 74 75 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 73 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.
75 76 77 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 75 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.
85 86 87 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 85 def total_payment_amount_current_year @total_payment_amount_current_year end |
#total_unapplied_payments ⇒ Double
Returns The total number of unapplied payments.
61 62 63 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 61 def total_unapplied_payments @total_unapplied_payments end |
Instance Method Details
#as_json(options = {}) ⇒ object
Returns This object as a JSON key-value structure.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 94 def as_json(={}) { 'groupKey' => @group_key, '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, 'totalCollectedPastThirtyDays' => @total_collected_past_thirty_days, 'totalInvoicesPaidPastThirtyDays' => @total_invoices_paid_past_thirty_days, 'percentageOfTotalAr90DaysPastDue' => @percentage_of_total_ar90_days_past_due, } end |
#to_json(*options) ⇒ String
Returns This object converted to a JSON string.
121 122 123 |
# File 'lib/lockstep_sdk/models/ar_header_info_model.rb', line 121 def to_json(*) "[#{as_json(*).to_json(*)}]" end |