Class: TripletexRubyClient::Posting

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Posting

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.has_key?(:'amortizationEndDate')
    self.amortization_end_date = attributes[:'amortizationEndDate']
  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?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'closeGroup')
    self.close_group = attributes[:'closeGroup']
  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?(:'row')
    self.row = attributes[:'row']
  end

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



31
32
33
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 31

def 
  @account
end

#amortization_account ⇒ Object

The Amortization account. AmortizationAccountId, amortizationStartDate and amortizationEndDate should be provided. If amortizationStartDate and amortizationEndDate are provided, while amortizationAccountId is NULL, then the default amortization account will be used.



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

def 
  @amortization_account
end

#amortization_end_date ⇒ Object

Returns the value of attribute amortization_end_date.



39
40
41
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 39

def amortization_end_date
  @amortization_end_date
end

#amortization_start_date ⇒ Object

Amortization start date. AmortizationAccountId, amortizationStartDate and amortizationEndDate should be provided.



37
38
39
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 37

def amortization_start_date
  @amortization_start_date
end

#amount ⇒ Object

Returns the value of attribute amount.



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

def amount
  @amount
end

#amount_currency ⇒ Object

Returns the value of attribute amount_currency.



57
58
59
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 57

def amount_currency
  @amount_currency
end

#amount_gross ⇒ Object

Returns the value of attribute amount_gross.



59
60
61
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 59

def amount_gross
  @amount_gross
end

#amount_gross_currency ⇒ Object

Returns the value of attribute amount_gross_currency.



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

def amount_gross_currency
  @amount_gross_currency
end

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#close_group ⇒ Object

Returns the value of attribute close_group.



65
66
67
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 65

def close_group
  @close_group
end

#currency ⇒ Object

Returns the value of attribute currency.



63
64
65
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 63

def currency
  @currency
end

#customer ⇒ Object

Returns the value of attribute customer.



41
42
43
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 41

def customer
  @customer
end

#date ⇒ Object

Returns the value of attribute date.



27
28
29
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 27

def date
  @date
end

#department ⇒ Object

Returns the value of attribute department.



51
52
53
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 51

def department
  @department
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#employee ⇒ Object

Returns the value of attribute employee.



45
46
47
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 45

def employee
  @employee
end

#external_ref ⇒ Object

External reference for identifying payment basis of the posting, e.g., KID, customer identification or credit note number.



76
77
78
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 76

def external_ref
  @external_ref
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#invoice_number ⇒ Object

Returns the value of attribute invoice_number.



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

def invoice_number
  @invoice_number
end

#product ⇒ Object

Returns the value of attribute product.



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

def product
  @product
end

#project ⇒ Object

Returns the value of attribute project.



47
48
49
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 47

def project
  @project
end

#row ⇒ Object

Returns the value of attribute row.



71
72
73
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 71

def row
  @row
end

#supplier ⇒ Object

Returns the value of attribute supplier.



43
44
45
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 43

def supplier
  @supplier
end

#system_generated ⇒ Object

Returns the value of attribute system_generated.



78
79
80
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 78

def system_generated
  @system_generated
end

#term_of_payment ⇒ Object

Returns the value of attribute term_of_payment.



69
70
71
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 69

def term_of_payment
  @term_of_payment
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#vat_type ⇒ Object

Returns the value of attribute vat_type.



53
54
55
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 53

def vat_type
  @vat_type
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

#voucher ⇒ Object

Returns the value of attribute voucher.



25
26
27
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 25

def voucher
  @voucher
end

Class Method Details

.attribute_map ⇒ Object

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



103
104
105
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
134
135
136
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 103

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'voucher' => :'voucher',
    :'date' => :'date',
    :'description' => :'description',
    :'account' => :'account',
    :'amortization_account' => :'amortizationAccount',
    :'amortization_start_date' => :'amortizationStartDate',
    :'amortization_end_date' => :'amortizationEndDate',
    :'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',
    :'currency' => :'currency',
    :'close_group' => :'closeGroup',
    :'invoice_number' => :'invoiceNumber',
    :'term_of_payment' => :'termOfPayment',
    :'row' => :'row',
    :'type' => :'type',
    :'external_ref' => :'externalRef',
    :'system_generated' => :'systemGenerated'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'voucher' => :'Voucher',
    :'date' => :'String',
    :'description' => :'String',
    :'account' => :'Account',
    :'amortization_account' => :'Account',
    :'amortization_start_date' => :'String',
    :'amortization_end_date' => :'String',
    :'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',
    :'currency' => :'Currency',
    :'close_group' => :'CloseGroup',
    :'invoice_number' => :'String',
    :'term_of_payment' => :'String',
    :'row' => :'Integer',
    :'type' => :'String',
    :'external_ref' => :'String',
    :'system_generated' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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. &&
       == o. &&
      amortization_start_date == o.amortization_start_date &&
      amortization_end_date == o.amortization_end_date &&
      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 &&
      currency == o.currency &&
      close_group == o.close_group &&
      invoice_number == o.invoice_number &&
      term_of_payment == o.term_of_payment &&
      row == o.row &&
      type == o.type &&
      external_ref == o.external_ref &&
      system_generated == o.system_generated
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



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 448

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



514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 514

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



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 427

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


414
415
416
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 414

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



420
421
422
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 420

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 307

def list_invalid_properties
  invalid_properties = Array.new
  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

  if !@row.nil? && @row < 0
    invalid_properties.push('invalid value for "row", must be greater than or equal to 0.')
  end

  if !@external_ref.nil? && @external_ref.to_s.length > 100
    invalid_properties.push('invalid value for "external_ref", 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



494
495
496
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 494

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



500
501
502
503
504
505
506
507
508
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 500

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



488
489
490
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 488

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



326
327
328
329
330
331
332
333
 
# File 'lib/tripletex_ruby_client/models/posting.rb', line 326

def valid?
  return false if !@invoice_number.nil? && @invoice_number.to_s.length > 100
  return false if !@row.nil? && @row < 0
  type_validator = EnumAttributeValidator.new('String', ['INCOMING_PAYMENT', 'INCOMING_PAYMENT_OPPOSITE', 'INVOICE_EXPENSE', 'OUTGOING_INVOICE_CUSTOMER_POSTING'])
  return false unless type_validator.valid?(@type)
  return false if !@external_ref.nil? && @external_ref.to_s.length > 100
  true
end