Class: LockstepSdk::PaymentModel

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

Overview

A Payment represents money sent from one company to another. A single payment may contain payments for one or more invoices; it is also possible for payments to be made in advance of an invoice, for example, as a deposit. The creator of the Payment is identified by the CustomerId field, and the recipient of the Payment is identified by the CompanyId field. Most Payments are uniquely identified both by a Lockstep Platform ID number and a customer ERP “key” that was generated by the system that originated the Payment. Payments that have not been fully applied have a nonzero UnappliedAmount value, which represents a deposit that has been paid and not yet applied to an Invoice.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ PaymentModel

Initialize the PaymentModel using the provided prototype



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
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 31

def initialize(params = {})
    @group_key = params.dig(:group_key)
    @payment_id = params.dig(:payment_id)
    @company_id = params.dig(:company_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)
    @payment_type = params.dig(:payment_type)
    @tender_type = params.dig(:tender_type)
    @is_open = params.dig(:is_open)
    @memo_text = params.dig(:memo_text)
    @payment_date = params.dig(:payment_date)
    @post_date = params.dig(:post_date)
    @payment_amount = params.dig(:payment_amount)
    @unapplied_amount = params.dig(:unapplied_amount)
    @currency_code = params.dig(:currency_code)
    @reference_code = params.dig(:reference_code)
    @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)
    @is_voided = params.dig(:is_voided)
    @in_dispute = params.dig(:in_dispute)
    @currency_rate = params.dig(:currency_rate)
    @base_currency_payment_amount = params.dig(:base_currency_payment_amount)
    @base_currency_unapplied_amount = params.dig(:base_currency_unapplied_amount)
    @service_fabric_status = params.dig(:service_fabric_status)
    @source_modified_date = params.dig(:source_modified_date)
    @applications = params.dig(:applications)
    @notes = params.dig(:notes)
    @attachments = params.dig(:attachments)
    @custom_field_definitions = params.dig(:custom_field_definitions)
    @custom_field_values = params.dig(:custom_field_values)
end

Instance Attribute Details

#app_enrollment_id ⇒ Uuid 



149
150
151
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 149

def app_enrollment_id
  @app_enrollment_id
end

#applications ⇒ PaymentAppliedModel 



181
182
183
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 181

def applications
  @applications
end

#attachments ⇒ AttachmentModel 



189
190
191
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 189

def attachments
  @attachments
end

#base_currency_payment_amount ⇒ Double 



165
166
167
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 165

def base_currency_payment_amount
  @base_currency_payment_amount
end

#base_currency_unapplied_amount ⇒ Double 



169
170
171
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 169

def base_currency_unapplied_amount
  @base_currency_unapplied_amount
end

#company_id ⇒ Uuid 



77
78
79
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 77

def company_id
  @company_id
end

#created ⇒ Date-time 



133
134
135
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 133

def created
  @created
end

#created_user_id ⇒ Uuid 



137
138
139
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 137

def created_user_id
  @created_user_id
end

#currency_code ⇒ String 



125
126
127
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 125

def currency_code
  @currency_code
end

#currency_rate ⇒ Double 



161
162
163
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 161

def currency_rate
  @currency_rate
end

#custom_field_definitions ⇒ CustomFieldDefinitionModel 



193
194
195
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 193

def custom_field_definitions
  @custom_field_definitions
end

#custom_field_values ⇒ CustomFieldValueModel 



197
198
199
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 197

def custom_field_values
  @custom_field_values
end

#erp_key ⇒ String 



81
82
83
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 81

def erp_key
  @erp_key
end

#erp_write_status ⇒ ErpWriteStatuses 



85
86
87
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 85

def erp_write_status
  @erp_write_status
end

#erp_write_status_name ⇒ String 



89
90
91
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 89

def erp_write_status_name
  @erp_write_status_name
end

#group_key ⇒ Uuid 



69
70
71
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 69

def group_key
  @group_key
end

#in_dispute ⇒ Boolean 



157
158
159
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 157

def in_dispute
  @in_dispute
end

#is_open ⇒ Boolean 



101
102
103
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 101

def is_open
  @is_open
end

#is_voided ⇒ Boolean 



153
154
155
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 153

def is_voided
  @is_voided
end

#memo_text ⇒ String 



105
106
107
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 105

def memo_text
  @memo_text
end

#modified ⇒ Date-time 



141
142
143
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 141

def modified
  @modified
end

#modified_user_id ⇒ Uuid 



145
146
147
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 145

def modified_user_id
  @modified_user_id
end

#notes ⇒ NoteModel 



185
186
187
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 185

def notes
  @notes
end

#payment_amount ⇒ Double 



117
118
119
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 117

def payment_amount
  @payment_amount
end

#payment_date ⇒ Date 



109
110
111
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 109

def payment_date
  @payment_date
end

#payment_id ⇒ Uuid 



73
74
75
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 73

def payment_id
  @payment_id
end

#payment_type ⇒ String 



93
94
95
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 93

def payment_type
  @payment_type
end

#post_date ⇒ Date 



113
114
115
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 113

def post_date
  @post_date
end

#reference_code ⇒ String 



129
130
131
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 129

def reference_code
  @reference_code
end

#service_fabric_status ⇒ String 



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

def service_fabric_status
  @service_fabric_status
end

#source_modified_date ⇒ Date-time 



177
178
179
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 177

def source_modified_date
  @source_modified_date
end

#tender_type ⇒ String 



97
98
99
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 97

def tender_type
  @tender_type
end

#unapplied_amount ⇒ Double 



121
122
123
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 121

def unapplied_amount
  @unapplied_amount
end

Instance Method Details

#as_json(options = {}) ⇒ object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 201

def as_json(options={})
    {
        'groupKey' => @group_key,
        'paymentId' => @payment_id,
        'companyId' => @company_id,
        'erpKey' => @erp_key,
        'erpWriteStatus' => @erp_write_status,
        'erpWriteStatusName' => @erp_write_status_name,
        'paymentType' => @payment_type,
        'tenderType' => @tender_type,
        'isOpen' => @is_open,
        'memoText' => @memo_text,
        'paymentDate' => @payment_date,
        'postDate' => @post_date,
        'paymentAmount' => @payment_amount,
        'unappliedAmount' => @unapplied_amount,
        'currencyCode' => @currency_code,
        'referenceCode' => @reference_code,
        'created' => @created,
        'createdUserId' => @created_user_id,
        'modified' => @modified,
        'modifiedUserId' => @modified_user_id,
        'appEnrollmentId' => @app_enrollment_id,
        'isVoided' => @is_voided,
        'inDispute' => @in_dispute,
        'currencyRate' => @currency_rate,
        'baseCurrencyPaymentAmount' => @base_currency_payment_amount,
        'baseCurrencyUnappliedAmount' => @base_currency_unapplied_amount,
        'serviceFabricStatus' => @service_fabric_status,
        'sourceModifiedDate' => @source_modified_date,
        'applications' => @applications,
        'notes' => @notes,
        'attachments' => @attachments,
        'customFieldDefinitions' => @custom_field_definitions,
        'customFieldValues' => @custom_field_values,
    }
end

#to_json(*options) ⇒ String 



241
242
243
 
# File 'lib/lockstep_sdk/models/payment_model.rb', line 241

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