Class: LockstepSdk::ArAgingHeaderInfoModel

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

Overview

Aggregated Accounts Receivable Aging information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ ArAgingHeaderInfoModel

Initialize the ArAgingHeaderInfoModel using the provided prototype



26
27
28
29
30
31
32
33
34
 
# File 'lib/lockstep_sdk/models/ar_aging_header_info_model.rb', line 26

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @report_bucket = params.dig(:report_bucket)
    @total_customers = params.dig(:total_customers)
    @total_invoices_outstanding = params.dig(:total_invoices_outstanding)
    @total_outstanding_amount = params.dig(:total_outstanding_amount)
    @total_ar_amount = params.dig(:total_ar_amount)
    @percentage_of_total_ar = params.dig(:percentage_of_total_ar)
end

Instance Attribute Details

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



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

def group_key
  @group_key
end

#percentage_of_total_ar ⇒ Double

Returns Portion of Total AR this data represents.

Returns:

  • (Double) —

    Portion of Total AR this data represents.



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

def percentage_of_total_ar
  @percentage_of_total_ar
end

#report_bucket ⇒ String

Returns The aging bucket this data belongs to.

Returns:

  • (String) —

    The aging bucket this data belongs to.



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

def report_bucket
  @report_bucket
end

#total_ar_amount ⇒ Double

Returns The total amount for AR.

Returns:

  • (Double) —

    The total amount for AR.



47
48
49
 
# File 'lib/lockstep_sdk/models/ar_aging_header_info_model.rb', line 47

def total_ar_amount
  @total_ar_amount
end

#total_customers ⇒ Int32

Returns The total number of customers.

Returns:

  • (Int32) —

    The total number of customers.



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

def total_customers
  @total_customers
end

#total_invoices_outstanding ⇒ Int32

Returns The total number of invoices outstanding.

Returns:

  • (Int32) —

    The total number of invoices outstanding.



43
44
45
 
# File 'lib/lockstep_sdk/models/ar_aging_header_info_model.rb', line 43

def total_invoices_outstanding
  @total_invoices_outstanding
end

#total_outstanding_amount ⇒ Double

Returns The total amount outstanding.

Returns:

  • (Double) —

    The total amount outstanding.



45
46
47
 
# File 'lib/lockstep_sdk/models/ar_aging_header_info_model.rb', line 45

def total_outstanding_amount
  @total_outstanding_amount
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



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/lockstep_sdk/models/ar_aging_header_info_model.rb', line 52

def as_json(options={})
    {
        'groupKey' => @group_key,
        'reportBucket' => @report_bucket,
        'totalCustomers' => @total_customers,
        'totalInvoicesOutstanding' => @total_invoices_outstanding,
        'totalOutstandingAmount' => @total_outstanding_amount,
        'totalArAmount' => @total_ar_amount,
        'percentageOfTotalAr' => @percentage_of_total_ar,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



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

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