Class: LockstepSdk::InvoiceSummaryModel

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

Overview

Contains summarized data for an invoice

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ InvoiceSummaryModel

Initialize the InvoiceSummaryModel using the provided prototype



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 28

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @customer_id = params.dig(:customer_id)
    @invoice_id = params.dig(:invoice_id)
    @invoice_number = params.dig(:invoice_number)
    @invoice_date = params.dig(:invoice_date)
    @customer_name = params.dig(:customer_name)
    @status = params.dig(:status)
    @payment_due_date = params.dig(:payment_due_date)
    @invoice_amount = params.dig(:invoice_amount)
    @outstanding_balance = params.dig(:outstanding_balance)
    @invoice_type_code = params.dig(:invoice_type_code)
    @newest_activity = params.dig(:newest_activity)
    @days_past_due = params.dig(:days_past_due)
    @payment_numbers = params.dig(:payment_numbers)
    @payment_ids = params.dig(:payment_ids)
end

Instance Attribute Details

#customer_id ⇒ Uuid

Returns The ID number of the counterparty for the invoice, for example, a customer or vendor.

Returns:

  • (Uuid) —

    The ID number of the counterparty for the invoice, for example, a customer or vendor.



52
53
54
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 52

def customer_id
  @customer_id
end

#customer_name ⇒ String

Returns The name of the counterparty for the invoice, for example, a customer or vendor.

Returns:

  • (String) —

    The name of the counterparty for the invoice, for example, a customer or vendor.



68
69
70
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 68

def customer_name
  @customer_name
end

#days_past_due ⇒ Int32

Returns The number of days this Invoice is past due.

Returns:

  • (Int32) —

    The number of days this Invoice is past due.



96
97
98
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 96

def days_past_due
  @days_past_due
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).



48
49
50
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 48

def group_key
  @group_key
end

#invoice_amount ⇒ Double

Returns The total amount of the Invoice.

Returns:

  • (Double) —

    The total amount of the Invoice.



80
81
82
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 80

def invoice_amount
  @invoice_amount
end

#invoice_date ⇒ Date

Returns The reporting date for this invoice.

Returns:

  • (Date) —

    The reporting date for this invoice.



64
65
66
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 64

def invoice_date
  @invoice_date
end

#invoice_id ⇒ Uuid

Returns The unique ID number of this invoice.

Returns:

  • (Uuid) —

    The unique ID number of this invoice.



56
57
58
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 56

def invoice_id
  @invoice_id
end

#invoice_number ⇒ String

Returns A reference code that is used to identify this invoice. The meaning of this field is specific to the ERP or accounting system used by the user.

Returns:

  • (String) —

    A reference code that is used to identify this invoice. The meaning of this field is specific to the ERP or accounting system used by the user.



60
61
62
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 60

def invoice_number
  @invoice_number
end

#invoice_type_code ⇒ String

Returns A code identifying the type of this Invoice.

Returns:

  • (String) —

    A code identifying the type of this Invoice.



88
89
90
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 88

def invoice_type_code
  @invoice_type_code
end

#newest_activity ⇒ Date

Returns The date stamp for the newest Activity on this Invoice.

Returns:

  • (Date) —

    The date stamp for the newest Activity on this Invoice.



92
93
94
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 92

def newest_activity
  @newest_activity
end

#outstanding_balance ⇒ Double

Returns The remaining balance value of this invoice.

Returns:

  • (Double) —

    The remaining balance value of this invoice.



84
85
86
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 84

def outstanding_balance
  @outstanding_balance
end

#payment_due_date ⇒ Date

Returns The due date of the invoice.

Returns:

  • (Date) —

    The due date of the invoice.



76
77
78
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 76

def payment_due_date
  @payment_due_date
end

#payment_ids ⇒ Uuid

Returns The ids of the payments associated to this invoice.

Returns:

  • (Uuid) —

    The ids of the payments associated to this invoice.



104
105
106
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 104

def payment_ids
  @payment_ids
end

#payment_numbers ⇒ String

Returns The memo text of the payments associated to this invoice.

Returns:

  • (String) —

    The memo text of the payments associated to this invoice.



100
101
102
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 100

def payment_numbers
  @payment_numbers
end

#status ⇒ String

Returns The status of the invoice.

Returns:

  • (String) —

    The status of the invoice.



72
73
74
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 72

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 108

def as_json(options={})
    {
        'groupKey' => @group_key,
        'customerId' => @customer_id,
        'invoiceId' => @invoice_id,
        'invoiceNumber' => @invoice_number,
        'invoiceDate' => @invoice_date,
        'customerName' => @customer_name,
        'status' => @status,
        'paymentDueDate' => @payment_due_date,
        'invoiceAmount' => @invoice_amount,
        'outstandingBalance' => @outstanding_balance,
        'invoiceTypeCode' => @invoice_type_code,
        'newestActivity' => @newest_activity,
        'daysPastDue' => @days_past_due,
        'paymentNumbers' => @payment_numbers,
        'paymentIds' => @payment_ids,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



130
131
132
 
# File 'lib/lockstep_sdk/models/invoice_summary_model.rb', line 130

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