Class: LockstepSdk::CreditMemoAppliedModel

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

Overview

Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds. Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice, Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid using this Credit.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ CreditMemoAppliedModel

Initialize the CreditMemoAppliedModel using the provided prototype



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 29

def initialize(params = {})
    @credit_memo_applied_id = params.dig(:credit_memo_applied_id)
    @group_key = params.dig(:group_key)
    @invoice_id = params.dig(:invoice_id)
    @credit_memo_invoice_id = params.dig(:credit_memo_invoice_id)
    @erp_key = params.dig(:erp_key)
    @erp_write_status = params.dig(:erp_write_status)
    @erp_write_status_name = params.dig(:erp_write_status_name)
    @entry_number = params.dig(:entry_number)
    @apply_to_invoice_date = params.dig(:apply_to_invoice_date)
    @credit_memo_applied_amount = params.dig(:credit_memo_applied_amount)
    @created = params.dig(:created)
    @created_user_id = params.dig(:created_user_id)
    @modified = params.dig(:modified)
    @modified_user_id = params.dig(:modified_user_id)
    @app_enrollment_id = params.dig(:app_enrollment_id)
    @source_modified_date = params.dig(:source_modified_date)
    @attachments = params.dig(:attachments)
    @notes = params.dig(:notes)
    @custom_field_definitions = params.dig(:custom_field_definitions)
    @custom_field_values = params.dig(:custom_field_values)
    @credit_memo_invoice = params.dig(:credit_memo_invoice)
    @invoice = params.dig(:invoice)
end

Instance Attribute Details

#app_enrollment_id ⇒ Uuid 



112
113
114
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 112

def app_enrollment_id
  @app_enrollment_id
end

#apply_to_invoice_date ⇒ Date-time 



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

def apply_to_invoice_date
  @apply_to_invoice_date
end

#attachments ⇒ AttachmentModel 



120
121
122
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 120

def attachments
  @attachments
end

#created ⇒ Date-time 



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

def created
  @created
end

#created_user_id ⇒ Uuid 



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

def created_user_id
  @created_user_id
end

#credit_memo_applied_amount ⇒ Double 



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

def credit_memo_applied_amount
  @credit_memo_applied_amount
end

#credit_memo_applied_id ⇒ Uuid 



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

def credit_memo_applied_id
  @credit_memo_applied_id
end

#credit_memo_invoice ⇒ InvoiceModel 



136
137
138
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 136

def credit_memo_invoice
  @credit_memo_invoice
end

#credit_memo_invoice_id ⇒ Uuid 



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

def credit_memo_invoice_id
  @credit_memo_invoice_id
end

#custom_field_definitions ⇒ CustomFieldDefinitionModel 



128
129
130
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 128

def custom_field_definitions
  @custom_field_definitions
end

#custom_field_values ⇒ CustomFieldValueModel 



132
133
134
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 132

def custom_field_values
  @custom_field_values
end

#entry_number ⇒ Int32 



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

def entry_number
  @entry_number
end

#erp_key ⇒ String 



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

def erp_key
  @erp_key
end

#erp_write_status ⇒ ErpWriteStatuses 



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

def erp_write_status
  @erp_write_status
end

#erp_write_status_name ⇒ String 



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

def erp_write_status_name
  @erp_write_status_name
end

#group_key ⇒ Uuid 



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

def group_key
  @group_key
end

#invoice ⇒ InvoiceModel 



140
141
142
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 140

def invoice
  @invoice
end

#invoice_id ⇒ Uuid 



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

def invoice_id
  @invoice_id
end

#modified ⇒ Date-time 



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

def modified
  @modified
end

#modified_user_id ⇒ Uuid 



108
109
110
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 108

def modified_user_id
  @modified_user_id
end

#notes ⇒ NoteModel 



124
125
126
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 124

def notes
  @notes
end

#source_modified_date ⇒ Date-time 



116
117
118
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 116

def source_modified_date
  @source_modified_date
end

Instance Method Details

#as_json(options = {}) ⇒ object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 144

def as_json(options={})
    {
        'creditMemoAppliedId' => @credit_memo_applied_id,
        'groupKey' => @group_key,
        'invoiceId' => @invoice_id,
        'creditMemoInvoiceId' => @credit_memo_invoice_id,
        'erpKey' => @erp_key,
        'erpWriteStatus' => @erp_write_status,
        'erpWriteStatusName' => @erp_write_status_name,
        'entryNumber' => @entry_number,
        'applyToInvoiceDate' => @apply_to_invoice_date,
        'creditMemoAppliedAmount' => @credit_memo_applied_amount,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
        'appEnrollmentId' => @app_enrollment_id,
        'sourceModifiedDate' => @source_modified_date,
        'attachments' => @attachments,
        'notes' => @notes,
        'customFieldDefinitions' => @custom_field_definitions,
        'customFieldValues' => @custom_field_values,
        'creditMemoInvoice' => @credit_memo_invoice,
        'invoice' => @invoice,
    }
end

#to_json(*options) ⇒ String 



173
174
175
 
# File 'lib/lockstep_sdk/models/credit_memo_applied_model.rb', line 173

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