Class: TripletexRubyClient::SupplierInvoice

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SupplierInvoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



117
118
119
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
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
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 117

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

In the company’s currency, typically NOK. Is 0 if value is missing.



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

def amount
  @amount
end

#amount_currency ⇒ Object

In the specified currency.



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

def amount_currency
  @amount_currency
end

#amount_excluding_vat ⇒ Object

Amount excluding VAT (NOK). Is 0 if value is missing.



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

def amount_excluding_vat
  @amount_excluding_vat
end

#amount_excluding_vat_currency ⇒ Object

Amount excluding VAT in the specified currency. Is 0 if value is missing.



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

def amount_excluding_vat_currency
  @amount_excluding_vat_currency
end

#approval_list_elements ⇒ Object

Returns the value of attribute approval_list_elements.



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

def approval_list_elements
  @approval_list_elements
end

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#invoice_date ⇒ Object

Returns the value of attribute invoice_date.



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

def invoice_date
  @invoice_date
end

#invoice_due_date ⇒ Object

Returns the value of attribute invoice_due_date.



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

def invoice_due_date
  @invoice_due_date
end

#invoice_number ⇒ Object

Invoice number



24
25
26
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 24

def invoice_number
  @invoice_number
end

#is_credit_note ⇒ Object

Returns the value of attribute is_credit_note.



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

def is_credit_note
  @is_credit_note
end

#kid_or_receiver_reference ⇒ Object

KID or message



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

def kid_or_receiver_reference
  @kid_or_receiver_reference
end

#order_lines ⇒ Object

Returns the value of attribute order_lines.



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

def order_lines
  @order_lines
end

#original_invoice_document_id ⇒ Object

Returns the value of attribute original_invoice_document_id.



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

def original_invoice_document_id
  @original_invoice_document_id
end

#payments ⇒ Object

Returns the value of attribute payments.



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

def payments
  @payments
end

#supplier ⇒ Object

The invoice supplier



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

def supplier
  @supplier
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

#voucher ⇒ Object

The invoice voucher.



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

def voucher
  @voucher
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'invoice_number' => :'invoiceNumber',
    :'invoice_date' => :'invoiceDate',
    :'supplier' => :'supplier',
    :'invoice_due_date' => :'invoiceDueDate',
    :'kid_or_receiver_reference' => :'kidOrReceiverReference',
    :'voucher' => :'voucher',
    :'amount' => :'amount',
    :'amount_currency' => :'amountCurrency',
    :'amount_excluding_vat' => :'amountExcludingVat',
    :'amount_excluding_vat_currency' => :'amountExcludingVatCurrency',
    :'currency' => :'currency',
    :'is_credit_note' => :'isCreditNote',
    :'order_lines' => :'orderLines',
    :'payments' => :'payments',
    :'original_invoice_document_id' => :'originalInvoiceDocumentId',
    :'approval_list_elements' => :'approvalListElements'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 90

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'invoice_number' => :'String',
    :'invoice_date' => :'String',
    :'supplier' => :'Supplier',
    :'invoice_due_date' => :'String',
    :'kid_or_receiver_reference' => :'String',
    :'voucher' => :'Voucher',
    :'amount' => :'Float',
    :'amount_currency' => :'Float',
    :'amount_excluding_vat' => :'Float',
    :'amount_excluding_vat_currency' => :'Float',
    :'currency' => :'Currency',
    :'is_credit_note' => :'BOOLEAN',
    :'order_lines' => :'Array<OrderLine>',
    :'payments' => :'Array<Posting>',
    :'original_invoice_document_id' => :'Integer',
    :'approval_list_elements' => :'Array<VoucherApprovalListElement>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      invoice_number == o.invoice_number &&
      invoice_date == o.invoice_date &&
      supplier == o.supplier &&
      invoice_due_date == o.invoice_due_date &&
      kid_or_receiver_reference == o.kid_or_receiver_reference &&
      voucher == o.voucher &&
      amount == o.amount &&
      amount_currency == o.amount_currency &&
      amount_excluding_vat == o.amount_excluding_vat &&
      amount_excluding_vat_currency == o.amount_excluding_vat_currency &&
      currency == o.currency &&
      is_credit_note == o.is_credit_note &&
      order_lines == o.order_lines &&
      payments == o.payments &&
      original_invoice_document_id == o.original_invoice_document_id &&
      approval_list_elements == o.approval_list_elements
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



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
363
364
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 328

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 394

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



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

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


294
295
296
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 300

def hash
  [id, version, changes, url, invoice_number, invoice_date, supplier, invoice_due_date, kid_or_receiver_reference, voucher, amount, amount_currency, amount_excluding_vat, amount_excluding_vat_currency, currency, is_credit_note, order_lines, payments, original_invoice_document_id, approval_list_elements].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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 214

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 @invoice_date.nil?
    invalid_properties.push('invalid value for "invoice_date", invoice_date cannot be nil.')
  end

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

  if !@original_invoice_document_id.nil? && @original_invoice_document_id < 0
    invalid_properties.push('invalid value for "original_invoice_document_id", must be greater than or equal to 0.')
  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



374
375
376
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 374

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



380
381
382
383
384
385
386
387
388
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 380

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



368
369
370
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 368

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



237
238
239
240
241
242
243
 
# File 'lib/tripletex_ruby_client/models/supplier_invoice.rb', line 237

def valid?
  return false if !@invoice_number.nil? && @invoice_number.to_s.length > 100
  return false if @invoice_date.nil?
  return false if @invoice_due_date.nil?
  return false if !@original_invoice_document_id.nil? && @original_invoice_document_id < 0
  true
end