Class: TripletexRubyClient::HistoricalPosting

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/models/historical_posting.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HistoricalPosting

Initializes the object

Parameters:

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

    Model attributes in the form of hash



137
138
139
140
141
142
143
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
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
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 137

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?(:'voucher')
    self.voucher = attributes[:'voucher']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

The ledger account of the posting.



32
33
34
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 32

def 
  @account
end

#amount ⇒ Object

The posting amount in company currency. Important: The amounts in this amount field must have sum = 0 on all the dates. If multiple postings with different dates, then the sum must be 0 on each of the dates.



49
50
51
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 49

def amount
  @amount
end

#amount_currency ⇒ Object

The posting amount in posting currency.



52
53
54
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 52

def amount_currency
  @amount_currency
end

#amount_gross ⇒ Object

The posting gross amount in company currency.



55
56
57
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 55

def amount_gross
  @amount_gross
end

#amount_gross_currency ⇒ Object

The posting gross amount in posting currency.



58
59
60
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 58

def amount_gross_currency
  @amount_gross_currency
end

#amount_vat ⇒ Object

The amount of vat on this posting in company currency (NOK).



61
62
63
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 61

def amount_vat
  @amount_vat
end

#changes ⇒ Object

Returns the value of attribute changes.



19
20
21
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 19

def changes
  @changes
end

#close_group ⇒ Object

Optional. Used to create a close group for postings.



73
74
75
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 73

def close_group
  @close_group
end

#currency ⇒ Object

Posting currency.



64
65
66
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 64

def currency
  @currency
end

#customer ⇒ Object

Returns the value of attribute customer.



34
35
36
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 34

def customer
  @customer
end

#date ⇒ Object

The posting date.



26
27
28
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 26

def date
  @date
end

#department ⇒ Object

Returns the value of attribute department.



44
45
46
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 44

def department
  @department
end

#description ⇒ Object

The description of the posting.



29
30
31
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 29

def description
  @description
end

#employee ⇒ Object

Returns the value of attribute employee.



38
39
40
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 38

def employee
  @employee
end

#id ⇒ Object

Returns the value of attribute id.



15
16
17
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 15

def id
  @id
end

#invoice_number ⇒ Object

Invoice number.



67
68
69
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 67

def invoice_number
  @invoice_number
end

#product ⇒ Object

Returns the value of attribute product.



42
43
44
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 42

def product
  @product
end

#project ⇒ Object

Returns the value of attribute project.



40
41
42
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 40

def project
  @project
end

#supplier ⇒ Object

Returns the value of attribute supplier.



36
37
38
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 36

def supplier
  @supplier
end

#term_of_payment ⇒ Object

Due date.



70
71
72
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 70

def term_of_payment
  @term_of_payment
end

#url ⇒ Object

Returns the value of attribute url.



21
22
23
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 21

def url
  @url
end

#vat_type ⇒ Object

Returns the value of attribute vat_type.



46
47
48
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 46

def vat_type
  @vat_type
end

#version ⇒ Object

Returns the value of attribute version.



17
18
19
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 17

def version
  @version
end

#voucher ⇒ Object

Returns the value of attribute voucher.



23
24
25
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 23

def voucher
  @voucher
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'voucher' => :'voucher',
    :'date' => :'date',
    :'description' => :'description',
    :'account' => :'account',
    :'customer' => :'customer',
    :'supplier' => :'supplier',
    :'employee' => :'employee',
    :'project' => :'project',
    :'product' => :'product',
    :'department' => :'department',
    :'vat_type' => :'vatType',
    :'amount' => :'amount',
    :'amount_currency' => :'amountCurrency',
    :'amount_gross' => :'amountGross',
    :'amount_gross_currency' => :'amountGrossCurrency',
    :'amount_vat' => :'amountVat',
    :'currency' => :'currency',
    :'invoice_number' => :'invoiceNumber',
    :'term_of_payment' => :'termOfPayment',
    :'close_group' => :'closeGroup'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 106

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'voucher' => :'Voucher',
    :'date' => :'String',
    :'description' => :'String',
    :'account' => :'Account',
    :'customer' => :'Customer',
    :'supplier' => :'Supplier',
    :'employee' => :'Employee',
    :'project' => :'Project',
    :'product' => :'Product',
    :'department' => :'Department',
    :'vat_type' => :'VatType',
    :'amount' => :'Float',
    :'amount_currency' => :'Float',
    :'amount_gross' => :'Float',
    :'amount_gross_currency' => :'Float',
    :'amount_vat' => :'Float',
    :'currency' => :'Currency',
    :'invoice_number' => :'String',
    :'term_of_payment' => :'String',
    :'close_group' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 312

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      voucher == o.voucher &&
      date == o.date &&
      description == o.description &&
       == o. &&
      customer == o.customer &&
      supplier == o.supplier &&
      employee == o.employee &&
      project == o.project &&
      product == o.product &&
      department == o.department &&
      vat_type == o.vat_type &&
      amount == o.amount &&
      amount_currency == o.amount_currency &&
      amount_gross == o.amount_gross &&
      amount_gross_currency == o.amount_gross_currency &&
      amount_vat == o.amount_vat &&
      currency == o.currency &&
      invoice_number == o.invoice_number &&
      term_of_payment == o.term_of_payment &&
      close_group == o.close_group
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



377
378
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
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 377

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



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 443

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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 356

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 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


343
344
345
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 343

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



349
350
351
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 349

def hash
  [id, version, changes, url, voucher, date, description, , customer, supplier, employee, project, product, department, vat_type, amount, amount_currency, amount_gross, amount_gross_currency, amount_vat, currency, invoice_number, term_of_payment, close_group].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



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
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 244

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

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

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

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

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

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

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

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

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

  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



423
424
425
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 423

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



429
430
431
432
433
434
435
436
437
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 429

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



417
418
419
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 417

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



287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/tripletex_ruby_client/models/historical_posting.rb', line 287

def valid?
  return false if @date.nil?
  return false if @account.nil?
  return false if @amount.nil?
  return false if @amount_currency.nil?
  return false if @amount_gross.nil?
  return false if @amount_gross_currency.nil?
  return false if @amount_vat.nil?
  return false if @currency.nil?
  return false if !@invoice_number.nil? && @invoice_number.to_s.length > 100
  true
end