Class: TripletexApi::Account

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
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
 
# File 'lib/tripletex_api/models/account.rb', line 149

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

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

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end

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

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

  if attributes.has_key?(:'number')
    self.number = attributes[:'number']
  end

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

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

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

  if attributes.has_key?(:'vatType')
    self.vat_type = attributes[:'vatType']
  end

  if attributes.has_key?(:'vatLocked')
    self.vat_locked = attributes[:'vatLocked']
  else
    self.vat_locked = false
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'isCloseable')
    self.is_closeable = attributes[:'isCloseable']
  else
    self.is_closeable = false
  end

  if attributes.has_key?(:'isApplicableForSupplierInvoice')
    self.is_applicable_for_supplier_invoice = attributes[:'isApplicableForSupplierInvoice']
  else
    self.is_applicable_for_supplier_invoice = false
  end

  if attributes.has_key?(:'requireReconciliation')
    self.require_reconciliation = attributes[:'requireReconciliation']
  else
    self.require_reconciliation = false
  end

  if attributes.has_key?(:'isInactive')
    self.is_inactive = attributes[:'isInactive']
  else
    self.is_inactive = false
  end

  if attributes.has_key?(:'isBankAccount')
    self. = attributes[:'isBankAccount']
  else
    self. = false
  end

  if attributes.has_key?(:'isInvoiceAccount')
    self. = attributes[:'isInvoiceAccount']
  else
    self. = false
  end

  if attributes.has_key?(:'bankAccountNumber')
    self. = attributes[:'bankAccountNumber']
  end

  if attributes.has_key?(:'bankAccountCountry')
    self. = attributes[:'bankAccountCountry']
  end

  if attributes.has_key?(:'bankName')
    self.bank_name = attributes[:'bankName']
  end

  if attributes.has_key?(:'bankAccountIBAN')
    self. = attributes[:'bankAccountIBAN']
  end

  if attributes.has_key?(:'bankAccountSWIFT')
    self. = attributes[:'bankAccountSWIFT']
  end

end

Instance Attribute Details

#bank_account_country ⇒ Object

Returns the value of attribute bank_account_country.



61
62
63
 
# File 'lib/tripletex_api/models/account.rb', line 61

def 
  @bank_account_country
end

#bank_account_iban ⇒ Object

Returns the value of attribute bank_account_iban.



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

def 
  @bank_account_iban
end

#bank_account_number ⇒ Object

Returns the value of attribute bank_account_number.



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

def 
  @bank_account_number
end

#bank_account_swift ⇒ Object

Returns the value of attribute bank_account_swift.



67
68
69
 
# File 'lib/tripletex_api/models/account.rb', line 67

def 
  @bank_account_swift
end

#bank_name ⇒ Object

Returns the value of attribute bank_name.



63
64
65
 
# File 'lib/tripletex_api/models/account.rb', line 63

def bank_name
  @bank_name
end

#changes ⇒ Object

Returns the value of attribute changes.



22
23
24
 
# File 'lib/tripletex_api/models/account.rb', line 22

def changes
  @changes
end

#currency ⇒ Object

If given, all entries on this account must have this currency.



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

def currency
  @currency
end

#description ⇒ Object

Returns the value of attribute description.



30
31
32
 
# File 'lib/tripletex_api/models/account.rb', line 30

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/tripletex_api/models/account.rb', line 18

def id
  @id
end

#is_applicable_for_supplier_invoice ⇒ Object

True if this account is applicable for supplier invoice registration.



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

def is_applicable_for_supplier_invoice
  @is_applicable_for_supplier_invoice
end

#is_bank_account ⇒ Object

Returns the value of attribute is_bank_account.



55
56
57
 
# File 'lib/tripletex_api/models/account.rb', line 55

def 
  @is_bank_account
end

#is_closeable ⇒ Object

True if it should be possible to close entries on this account and it is possible to filter on open entries.



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

def is_closeable
  @is_closeable
end

#is_inactive ⇒ Object

Inactive accounts will not show up in UI lists.



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

def is_inactive
  @is_inactive
end

#is_invoice_account ⇒ Object

Returns the value of attribute is_invoice_account.



57
58
59
 
# File 'lib/tripletex_api/models/account.rb', line 57

def 
  @is_invoice_account
end

#name ⇒ Object

Returns the value of attribute name.



28
29
30
 
# File 'lib/tripletex_api/models/account.rb', line 28

def name
  @name
end

#number ⇒ Object

Returns the value of attribute number.



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

def number
  @number
end

#require_reconciliation ⇒ Object

True if this account must be reconciled before the accounting period closure.



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

def require_reconciliation
  @require_reconciliation
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#url ⇒ Object

Returns the value of attribute url.



24
25
26
 
# File 'lib/tripletex_api/models/account.rb', line 24

def url
  @url
end

#vat_locked ⇒ Object

True if all entries on this account must have the vat type given by vatType.



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

def vat_locked
  @vat_locked
end

#vat_type ⇒ Object

The default vat type for this account.



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

def vat_type
  @vat_type
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/tripletex_api/models/account.rb', line 92

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'number' => :'number',
    :'name' => :'name',
    :'description' => :'description',
    :'type' => :'type',
    :'vat_type' => :'vatType',
    :'vat_locked' => :'vatLocked',
    :'currency' => :'currency',
    :'is_closeable' => :'isCloseable',
    :'is_applicable_for_supplier_invoice' => :'isApplicableForSupplierInvoice',
    :'require_reconciliation' => :'requireReconciliation',
    :'is_inactive' => :'isInactive',
    :'is_bank_account' => :'isBankAccount',
    :'is_invoice_account' => :'isInvoiceAccount',
    :'bank_account_number' => :'bankAccountNumber',
    :'bank_account_country' => :'bankAccountCountry',
    :'bank_name' => :'bankName',
    :'bank_account_iban' => :'bankAccountIBAN',
    :'bank_account_swift' => :'bankAccountSWIFT'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/tripletex_api/models/account.rb', line 120

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'number' => :'Integer',
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'vat_type' => :'VatType',
    :'vat_locked' => :'BOOLEAN',
    :'currency' => :'Currency',
    :'is_closeable' => :'BOOLEAN',
    :'is_applicable_for_supplier_invoice' => :'BOOLEAN',
    :'require_reconciliation' => :'BOOLEAN',
    :'is_inactive' => :'BOOLEAN',
    :'is_bank_account' => :'BOOLEAN',
    :'is_invoice_account' => :'BOOLEAN',
    :'bank_account_number' => :'String',
    :'bank_account_country' => :'Country',
    :'bank_name' => :'String',
    :'bank_account_iban' => :'String',
    :'bank_account_swift' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/tripletex_api/models/account.rb', line 400

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      number == o.number &&
      name == o.name &&
      description == o.description &&
      type == o.type &&
      vat_type == o.vat_type &&
      vat_locked == o.vat_locked &&
      currency == o.currency &&
      is_closeable == o.is_closeable &&
      is_applicable_for_supplier_invoice == o.is_applicable_for_supplier_invoice &&
      require_reconciliation == o.require_reconciliation &&
      is_inactive == o.is_inactive &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      bank_name == o.bank_name &&
       == o. &&
       == 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



463
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
 
# File 'lib/tripletex_api/models/account.rb', line 463

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = TripletexApi.const_get(type).new
    temp_model.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



529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/tripletex_api/models/account.rb', line 529

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


429
430
431
 
# File 'lib/tripletex_api/models/account.rb', line 429

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



435
436
437
 
# File 'lib/tripletex_api/models/account.rb', line 435

def hash
  [id, version, changes, url, number, name, description, type, vat_type, vat_locked, currency, is_closeable, is_applicable_for_supplier_invoice, require_reconciliation, is_inactive, , , , , bank_name, , ].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



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
 
# File 'lib/tripletex_api/models/account.rb', line 263

def list_invalid_properties
  invalid_properties = Array.new
  if @number.nil?
    invalid_properties.push("invalid value for 'number', number cannot be nil.")
  end

  if @number < 0
    invalid_properties.push("invalid value for 'number', must be greater than or equal to 0.")
  end

  if @name.nil?
    invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end

  if @name.to_s.length > 255
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.")
  end

  if !@bank_account_number.nil? && @bank_account_number.to_s.length > 100
    invalid_properties.push("invalid value for 'bank_account_number', the character length must be smaller than or equal to 100.")
  end

  if !@bank_name.nil? && @bank_name.to_s.length > 255
    invalid_properties.push("invalid value for 'bank_name', the character length must be smaller than or equal to 255.")
  end

  if !@bank_account_iban.nil? && @bank_account_iban.to_s.length > 100
    invalid_properties.push("invalid value for 'bank_account_iban', the character length must be smaller than or equal to 100.")
  end

  if !@bank_account_swift.nil? && @bank_account_swift.to_s.length > 100
    invalid_properties.push("invalid value for 'bank_account_swift', the character length must be smaller than or equal to 100.")
  end

  return 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



509
510
511
 
# File 'lib/tripletex_api/models/account.rb', line 509

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



515
516
517
518
519
520
521
522
523
 
# File 'lib/tripletex_api/models/account.rb', line 515

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



503
504
505
 
# File 'lib/tripletex_api/models/account.rb', line 503

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/tripletex_api/models/account.rb', line 302

def valid?
  return false if @number.nil?
  return false if @number < 0
  return false if @name.nil?
  return false if @name.to_s.length > 255
  type_validator = EnumAttributeValidator.new('String', ["ASSETS", "EQUITY", "LIABILITIES", "OPERATING_REVENUES", "OPERATING_EXPENSES", "INVESTMENT_INCOME", "COST_OF_CAPITAL", "TAX_ON_ORDINARY_ACTIVITIES", "EXTRAORDINARY_INCOME", "EXTRAORDINARY_COST", "TAX_ON_EXTRAORDINARY_ACTIVITIES", "ANNUAL_RESULT", "TRANSFERS_AND_ALLOCATIONS"])
  return false unless type_validator.valid?(@type)
  return false if !@bank_account_number.nil? && @bank_account_number.to_s.length > 100
  return false if !@bank_name.nil? && @bank_name.to_s.length > 255
  return false if !@bank_account_iban.nil? && @bank_account_iban.to_s.length > 100
  return false if !@bank_account_swift.nil? && @bank_account_swift.to_s.length > 100
  return true
end