Class: Propertyware::Account

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/models/account.rb

Overview

General Ledger Account

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Account

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/propertyware/models/account.rb', line 214

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Propertyware::Account` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Propertyware::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'account_code')
    self. = attributes[:'account_code']
  end

  if attributes.key?(:'account_number')
    self. = attributes[:'account_number']
  end

  if attributes.key?(:'account_type')
    self. = attributes[:'account_type']
  end

  if attributes.key?(:'active')
    self.active = attributes[:'active']
  end

  if attributes.key?(:'auto_apply_prepayment')
    self.auto_apply_prepayment = attributes[:'auto_apply_prepayment']
  end

  if attributes.key?(:'bank_account_holder')
    self. = attributes[:'bank_account_holder']
  end

  if attributes.key?(:'bank_account_number')
    self. = attributes[:'bank_account_number']
  end

  if attributes.key?(:'bank_address')
    self.bank_address = attributes[:'bank_address']
  end

  if attributes.key?(:'bank_address2')
    self.bank_address2 = attributes[:'bank_address2']
  end

  if attributes.key?(:'bank_city')
    self.bank_city = attributes[:'bank_city']
  end

  if attributes.key?(:'bank_institution')
    self.bank_institution = attributes[:'bank_institution']
  end

  if attributes.key?(:'bank_routing_number')
    self.bank_routing_number = attributes[:'bank_routing_number']
  end

  if attributes.key?(:'bank_state')
    self.bank_state = attributes[:'bank_state']
  end

  if attributes.key?(:'bank_zip')
    self.bank_zip = attributes[:'bank_zip']
  end

  if attributes.key?(:'cam_recovery_account')
    self. = attributes[:'cam_recovery_account']
  end

  if attributes.key?(:'created_by')
    self.created_by = attributes[:'created_by']
  end

  if attributes.key?(:'created_date_time')
    self.created_date_time = attributes[:'created_date_time']
  end

  if attributes.key?(:'discount_account')
    self. = attributes[:'discount_account']
  end

  if attributes.key?(:'escrow_account')
    self. = attributes[:'escrow_account']
  end

  if attributes.key?(:'exclude_from1099')
    self.exclude_from1099 = attributes[:'exclude_from1099']
  end

  if attributes.key?(:'exclude_from_pay_in_full')
    self.exclude_from_pay_in_full = attributes[:'exclude_from_pay_in_full']
  end

  if attributes.key?(:'exclude_late_fee')
    self.exclude_late_fee = attributes[:'exclude_late_fee']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'last_modified_by')
    self.last_modified_by = attributes[:'last_modified_by']
  end

  if attributes.key?(:'last_modified_date_time')
    self.last_modified_date_time = attributes[:'last_modified_date_time']
  end

  if attributes.key?(:'late_fee_applicable')
    self.late_fee_applicable = attributes[:'late_fee_applicable']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'parent_gl_account_id')
    self. = attributes[:'parent_gl_account_id']
  end

  if attributes.key?(:'parent_ref')
    self.parent_ref = attributes[:'parent_ref']
  end

  if attributes.key?(:'payment_priority')
    self.payment_priority = attributes[:'payment_priority']
  end

  if attributes.key?(:'rent_account')
    self. = attributes[:'rent_account']
  end

  if attributes.key?(:'section8')
    self.section8 = attributes[:'section8']
  end

  if attributes.key?(:'tax_account')
    self. = attributes[:'tax_account']
  end

  if attributes.key?(:'transfer_balance_to_retained_earnings')
    self.transfer_balance_to_retained_earnings = attributes[:'transfer_balance_to_retained_earnings']
  end
end

Instance Attribute Details

#account_code ⇒ Object

Account code.



20
21
22
 
# File 'lib/propertyware/models/account.rb', line 20

def 
  @account_code
end

#account_number ⇒ Object

Account number.



23
24
25
 
# File 'lib/propertyware/models/account.rb', line 23

def 
  @account_number
end

#account_type ⇒ Object

Account type.



26
27
28
 
# File 'lib/propertyware/models/account.rb', line 26

def 
  @account_type
end

#active ⇒ Object

Indicates if the account is active.



29
30
31
 
# File 'lib/propertyware/models/account.rb', line 29

def active
  @active
end

#auto_apply_prepayment ⇒ Object

Indicates if prepayments should be auto applied.



32
33
34
 
# File 'lib/propertyware/models/account.rb', line 32

def auto_apply_prepayment
  @auto_apply_prepayment
end

#bank_account_holder ⇒ Object

Bank account holder name.



35
36
37
 
# File 'lib/propertyware/models/account.rb', line 35

def 
  @bank_account_holder
end

#bank_account_number ⇒ Object

Bank account number.



38
39
40
 
# File 'lib/propertyware/models/account.rb', line 38

def 
  @bank_account_number
end

#bank_address ⇒ Object

Bank address.



41
42
43
 
# File 'lib/propertyware/models/account.rb', line 41

def bank_address
  @bank_address
end

#bank_address2 ⇒ Object

Bank address 2.



44
45
46
 
# File 'lib/propertyware/models/account.rb', line 44

def bank_address2
  @bank_address2
end

#bank_city ⇒ Object

Bank city.



47
48
49
 
# File 'lib/propertyware/models/account.rb', line 47

def bank_city
  @bank_city
end

#bank_institution ⇒ Object

Bank institution name.



50
51
52
 
# File 'lib/propertyware/models/account.rb', line 50

def bank_institution
  @bank_institution
end

#bank_routing_number ⇒ Object

Bank account routing number.



53
54
55
 
# File 'lib/propertyware/models/account.rb', line 53

def bank_routing_number
  @bank_routing_number
end

#bank_state ⇒ Object

Bank state.



56
57
58
 
# File 'lib/propertyware/models/account.rb', line 56

def bank_state
  @bank_state
end

#bank_zip ⇒ Object

Bank zip code.



59
60
61
 
# File 'lib/propertyware/models/account.rb', line 59

def bank_zip
  @bank_zip
end

#cam_recovery_account ⇒ Object

Indicates if account is a CAM recovery account.



62
63
64
 
# File 'lib/propertyware/models/account.rb', line 62

def 
  @cam_recovery_account
end

#created_by ⇒ Object

User who created the record.



65
66
67
 
# File 'lib/propertyware/models/account.rb', line 65

def created_by
  @created_by
end

#created_date_time ⇒ Object

Date and time the record was created. (Timezone: UTC)



68
69
70
 
# File 'lib/propertyware/models/account.rb', line 68

def created_date_time
  @created_date_time
end

#discount_account ⇒ Object

Indicates if account is a discount account.



71
72
73
 
# File 'lib/propertyware/models/account.rb', line 71

def 
  @discount_account
end

#escrow_account ⇒ Object

Indicates if account is a escrow account.



74
75
76
 
# File 'lib/propertyware/models/account.rb', line 74

def 
  @escrow_account
end

#exclude_from1099 ⇒ Object

Indicates if account is excluded from Form1099.



77
78
79
 
# File 'lib/propertyware/models/account.rb', line 77

def exclude_from1099
  @exclude_from1099
end

#exclude_from_pay_in_full ⇒ Object

Indicates if account is excluded from paying in full.



80
81
82
 
# File 'lib/propertyware/models/account.rb', line 80

def exclude_from_pay_in_full
  @exclude_from_pay_in_full
end

#exclude_late_fee ⇒ Object

Indicates if excluding from late fees.



83
84
85
 
# File 'lib/propertyware/models/account.rb', line 83

def exclude_late_fee
  @exclude_late_fee
end

#id ⇒ Object

Unique identifier.



86
87
88
 
# File 'lib/propertyware/models/account.rb', line 86

def id
  @id
end

#last_modified_by ⇒ Object

User who last modified the record.



89
90
91
 
# File 'lib/propertyware/models/account.rb', line 89

def last_modified_by
  @last_modified_by
end

#last_modified_date_time ⇒ Object

Date and time the record was last modified. (Timezone: UTC)



92
93
94
 
# File 'lib/propertyware/models/account.rb', line 92

def last_modified_date_time
  @last_modified_date_time
end

#late_fee_applicable ⇒ Object

Indicates if a late fee is applicable.



95
96
97
 
# File 'lib/propertyware/models/account.rb', line 95

def late_fee_applicable
  @late_fee_applicable
end

#name ⇒ Object

Account name.



98
99
100
 
# File 'lib/propertyware/models/account.rb', line 98

def name
  @name
end

#parent_gl_account_id ⇒ Object

Parent account ID.



101
102
103
 
# File 'lib/propertyware/models/account.rb', line 101

def 
  @parent_gl_account_id
end

#parent_ref ⇒ Object

Parent account reference.



104
105
106
 
# File 'lib/propertyware/models/account.rb', line 104

def parent_ref
  @parent_ref
end

#payment_priority ⇒ Object

Account payment priority.



107
108
109
 
# File 'lib/propertyware/models/account.rb', line 107

def payment_priority
  @payment_priority
end

#rent_account ⇒ Object

Indicates if account is a rent account.



110
111
112
 
# File 'lib/propertyware/models/account.rb', line 110

def 
  @rent_account
end

#section8 ⇒ Object

Indicates if account is a section8 account.



113
114
115
 
# File 'lib/propertyware/models/account.rb', line 113

def section8
  @section8
end

#tax_account ⇒ Object

Indicates if account is a tax account.



116
117
118
 
# File 'lib/propertyware/models/account.rb', line 116

def 
  @tax_account
end

#transfer_balance_to_retained_earnings ⇒ Object

Indicates if the account balance should be transferred to retained earnings.



119
120
121
 
# File 'lib/propertyware/models/account.rb', line 119

def transfer_balance_to_retained_earnings
  @transfer_balance_to_retained_earnings
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



162
163
164
 
# File 'lib/propertyware/models/account.rb', line 162

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/propertyware/models/account.rb', line 122

def self.attribute_map
  {
    :'account_code' => :'accountCode',
    :'account_number' => :'accountNumber',
    :'account_type' => :'accountType',
    :'active' => :'active',
    :'auto_apply_prepayment' => :'autoApplyPrepayment',
    :'bank_account_holder' => :'bankAccountHolder',
    :'bank_account_number' => :'bankAccountNumber',
    :'bank_address' => :'bankAddress',
    :'bank_address2' => :'bankAddress2',
    :'bank_city' => :'bankCity',
    :'bank_institution' => :'bankInstitution',
    :'bank_routing_number' => :'bankRoutingNumber',
    :'bank_state' => :'bankState',
    :'bank_zip' => :'bankZip',
    :'cam_recovery_account' => :'camRecoveryAccount',
    :'created_by' => :'createdBy',
    :'created_date_time' => :'createdDateTime',
    :'discount_account' => :'discountAccount',
    :'escrow_account' => :'escrowAccount',
    :'exclude_from1099' => :'excludeFrom1099',
    :'exclude_from_pay_in_full' => :'excludeFromPayInFull',
    :'exclude_late_fee' => :'excludeLateFee',
    :'id' => :'id',
    :'last_modified_by' => :'lastModifiedBy',
    :'last_modified_date_time' => :'lastModifiedDateTime',
    :'late_fee_applicable' => :'lateFeeApplicable',
    :'name' => :'name',
    :'parent_gl_account_id' => :'parentGLAccountId',
    :'parent_ref' => :'parentRef',
    :'payment_priority' => :'paymentPriority',
    :'rent_account' => :'rentAccount',
    :'section8' => :'section8',
    :'tax_account' => :'taxAccount',
    :'transfer_balance_to_retained_earnings' => :'transferBalanceToRetainedEarnings'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



433
434
435
 
# File 'lib/propertyware/models/account.rb', line 433

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



207
208
209
210
 
# File 'lib/propertyware/models/account.rb', line 207

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/propertyware/models/account.rb', line 167

def self.openapi_types
  {
    :'account_code' => :'String',
    :'account_number' => :'String',
    :'account_type' => :'String',
    :'active' => :'Boolean',
    :'auto_apply_prepayment' => :'Boolean',
    :'bank_account_holder' => :'String',
    :'bank_account_number' => :'String',
    :'bank_address' => :'String',
    :'bank_address2' => :'String',
    :'bank_city' => :'String',
    :'bank_institution' => :'String',
    :'bank_routing_number' => :'String',
    :'bank_state' => :'String',
    :'bank_zip' => :'String',
    :'cam_recovery_account' => :'Boolean',
    :'created_by' => :'String',
    :'created_date_time' => :'Time',
    :'discount_account' => :'Boolean',
    :'escrow_account' => :'Boolean',
    :'exclude_from1099' => :'Boolean',
    :'exclude_from_pay_in_full' => :'Boolean',
    :'exclude_late_fee' => :'Boolean',
    :'id' => :'Integer',
    :'last_modified_by' => :'String',
    :'last_modified_date_time' => :'Time',
    :'late_fee_applicable' => :'Boolean',
    :'name' => :'String',
    :'parent_gl_account_id' => :'Integer',
    :'parent_ref' => :'String',
    :'payment_priority' => :'Integer',
    :'rent_account' => :'Boolean',
    :'section8' => :'Boolean',
    :'tax_account' => :'Boolean',
    :'transfer_balance_to_retained_earnings' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/propertyware/models/account.rb', line 379

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
       == o. &&
      active == o.active &&
      auto_apply_prepayment == o.auto_apply_prepayment &&
       == o. &&
       == o. &&
      bank_address == o.bank_address &&
      bank_address2 == o.bank_address2 &&
      bank_city == o.bank_city &&
      bank_institution == o.bank_institution &&
      bank_routing_number == o.bank_routing_number &&
      bank_state == o.bank_state &&
      bank_zip == o.bank_zip &&
       == o. &&
      created_by == o.created_by &&
      created_date_time == o.created_date_time &&
       == o. &&
       == o. &&
      exclude_from1099 == o.exclude_from1099 &&
      exclude_from_pay_in_full == o.exclude_from_pay_in_full &&
      exclude_late_fee == o.exclude_late_fee &&
      id == o.id &&
      last_modified_by == o.last_modified_by &&
      last_modified_date_time == o.last_modified_date_time &&
      late_fee_applicable == o.late_fee_applicable &&
      name == o.name &&
       == o. &&
      parent_ref == o.parent_ref &&
      payment_priority == o.payment_priority &&
       == o. &&
      section8 == o.section8 &&
       == o. &&
      transfer_balance_to_retained_earnings == o.transfer_balance_to_retained_earnings
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/propertyware/models/account.rb', line 464

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Propertyware.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/propertyware/models/account.rb', line 535

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/propertyware/models/account.rb', line 440

def build_from_hash(attributes)
  return unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


420
421
422
 
# File 'lib/propertyware/models/account.rb', line 420

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



426
427
428
 
# File 'lib/propertyware/models/account.rb', line 426

def hash
  [, , , active, auto_apply_prepayment, , , bank_address, bank_address2, bank_city, bank_institution, bank_routing_number, bank_state, bank_zip, , created_by, created_date_time, , , exclude_from1099, exclude_from_pay_in_full, exclude_late_fee, id, last_modified_by, last_modified_date_time, late_fee_applicable, name, , parent_ref, payment_priority, , section8, , transfer_balance_to_retained_earnings].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



366
367
368
369
 
# File 'lib/propertyware/models/account.rb', line 366

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



511
512
513
 
# File 'lib/propertyware/models/account.rb', line 511

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/propertyware/models/account.rb', line 517

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



505
506
507
 
# File 'lib/propertyware/models/account.rb', line 505

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



373
374
375
 
# File 'lib/propertyware/models/account.rb', line 373

def valid?
  true
end