Class: Buildium::GeneralLedgerJournalLineMessageGLAccount

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb

Overview

General ledger account the line item is related to.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeneralLedgerJournalLineMessageGLAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 148

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::GeneralLedgerJournalLineMessageGLAccount` 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 `Buildium::GeneralLedgerJournalLineMessageGLAccount`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'sub_accounts')
    if (value = attributes[:'sub_accounts']).is_a?(Array)
      self.sub_accounts = value
    end
  end

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

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

Instance Attribute Details

#account_number ⇒ Object

General ledger account number.



23
24
25
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 23

def 
  @account_number
end

#cash_flow_classification ⇒ Object

Describes the cash flow classification for the general ledger account.



50
51
52
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 50

def cash_flow_classification
  @cash_flow_classification
end

#default_account_name ⇒ Object

Indicates the original name of the general ledger account if it is a default account.



41
42
43
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 41

def 
  @default_account_name
end

#description ⇒ Object

Description of the general ledger account.



29
30
31
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 29

def description
  @description
end

#exclude_from_cash_balances ⇒ Object

Indicates whether transactions associated with the account should be excluded from cash balances.



53
54
55
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 53

def exclude_from_cash_balances
  @exclude_from_cash_balances
end

#id ⇒ Object

General ledger account unique identifier.



20
21
22
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 20

def id
  @id
end

#is_active ⇒ Object

Indicates whether the account is active.



59
60
61
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 59

def is_active
  @is_active
end

#is_bank_account ⇒ Object

Indicates whether the account is a bank account.



47
48
49
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 47

def 
  @is_bank_account
end

#is_contra_account ⇒ Object

Indicates whether the account is a contra account.



44
45
46
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 44

def 
  @is_contra_account
end

#is_default_gl_account ⇒ Object

Indicates if the general ledger account is a default for auto populating fields.



38
39
40
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 38

def 
  @is_default_gl_account
end

#name ⇒ Object

Name of the general ledger account.



26
27
28
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 26

def name
  @name
end

#parent_gl_account_id ⇒ Object

Unique identifier of the parent general ledger account, if applicable.



62
63
64
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 62

def 
  @parent_gl_account_id
end

#sub_accounts ⇒ Object

Children general ledger accounts. The relationship only goes one level deep.



56
57
58
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 56

def sub_accounts
  @sub_accounts
end

#sub_type ⇒ Object

Describes the subtype of the general ledger account.



35
36
37
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 35

def sub_type
  @sub_type
end

#type ⇒ Object

Describes the type of general ledger account.



32
33
34
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 32

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



108
109
110
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 108

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 87

def self.attribute_map
  {
    :'id' => :'Id',
    :'account_number' => :'AccountNumber',
    :'name' => :'Name',
    :'description' => :'Description',
    :'type' => :'Type',
    :'sub_type' => :'SubType',
    :'is_default_gl_account' => :'IsDefaultGLAccount',
    :'default_account_name' => :'DefaultAccountName',
    :'is_contra_account' => :'IsContraAccount',
    :'is_bank_account' => :'IsBankAccount',
    :'cash_flow_classification' => :'CashFlowClassification',
    :'exclude_from_cash_balances' => :'ExcludeFromCashBalances',
    :'sub_accounts' => :'SubAccounts',
    :'is_active' => :'IsActive',
    :'parent_gl_account_id' => :'ParentGLAccountId'
  }
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



310
311
312
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 310

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



140
141
142
143
144
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 140

def self.openapi_all_of
  [
  :'GLAccountMessage'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 134

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

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 113

def self.openapi_types
  {
    :'id' => :'Integer',
    :'account_number' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'sub_type' => :'String',
    :'is_default_gl_account' => :'Boolean',
    :'default_account_name' => :'String',
    :'is_contra_account' => :'Boolean',
    :'is_bank_account' => :'Boolean',
    :'cash_flow_classification' => :'String',
    :'exclude_from_cash_balances' => :'Boolean',
    :'sub_accounts' => :'Array<GLAccountMessage>',
    :'is_active' => :'Boolean',
    :'parent_gl_account_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      name == o.name &&
      description == o.description &&
      type == o.type &&
      sub_type == o.sub_type &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      cash_flow_classification == o.cash_flow_classification &&
      exclude_from_cash_balances == o.exclude_from_cash_balances &&
      sub_accounts == o.sub_accounts &&
      is_active == o.is_active &&
       == o.
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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 341

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 = Buildium.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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 412

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 317

def build_from_hash(attributes)
  return nil 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


297
298
299
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 303

def hash
  [id, , name, description, type, sub_type, , , , , cash_flow_classification, exclude_from_cash_balances, sub_accounts, is_active, ].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



226
227
228
229
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 226

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



388
389
390
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 388

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 394

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



382
383
384
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 382

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



233
234
235
236
237
238
239
240
241
 
# File 'lib/buildium-ruby/models/general_ledger_journal_line_message_gl_account.rb', line 233

def valid?
  type_validator = EnumAttributeValidator.new('String', ["Asset", "Liability", "Equity", "Income", "Expense"])
  return false unless type_validator.valid?(@type)
  sub_type_validator = EnumAttributeValidator.new('String', ["CurrentAsset", "FixedAsset", "CurrentLiability", "LongTermLiability", "Equity", "Income", "NonOperatingIncome", "OperatingExpenses", "NonOperatingExpenses"])
  return false unless sub_type_validator.valid?(@sub_type)
  cash_flow_classification_validator = EnumAttributeValidator.new('String', ["OperatingActivities", "InvestingActivities", "FinancingActivities"])
  return false unless cash_flow_classification_validator.valid?(@cash_flow_classification)
  true
end