Class: TripletexApi::Invoice

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/tripletex_api/models/invoice.rb', line 184

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

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

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

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

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

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

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

  if attributes.has_key?(:'deliveryDate')
    self.delivery_date = attributes[:'deliveryDate']
  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?(:'amountRoundoff')
    self.amount_roundoff = attributes[:'amountRoundoff']
  end

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#amount ⇒ Object

In the company’s currency, typically NOK.



54
55
56
 
# File 'lib/tripletex_api/models/invoice.rb', line 54

def amount
  @amount
end

#amount_currency ⇒ Object

In the specified currency.



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

def amount_currency
  @amount_currency
end

#amount_excluding_vat ⇒ Object

Amount excluding VAT (NOK).



60
61
62
 
# File 'lib/tripletex_api/models/invoice.rb', line 60

def amount_excluding_vat
  @amount_excluding_vat
end

#amount_excluding_vat_currency ⇒ Object

Amount excluding VAT in the specified currency.



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

def amount_excluding_vat_currency
  @amount_excluding_vat_currency
end

#amount_outstanding ⇒ Object

The amount outstanding based on the history collection, excluding reminders and any existing remits, in the invoice currency.



72
73
74
 
# File 'lib/tripletex_api/models/invoice.rb', line 72

def amount_outstanding
  @amount_outstanding
end

#amount_outstanding_total ⇒ Object

The amount outstanding based on the history collection and including the last reminder and any existing remits. This is the total invoice balance including reminders and remittances, in the invoice currency.



75
76
77
 
# File 'lib/tripletex_api/models/invoice.rb', line 75

def amount_outstanding_total
  @amount_outstanding_total
end

#amount_roundoff ⇒ Object

Amount of round off to nearest integer.



66
67
68
 
# File 'lib/tripletex_api/models/invoice.rb', line 66

def amount_roundoff
  @amount_roundoff
end

#amount_roundoff_currency ⇒ Object

Amount of round off to nearest integer in the specified currency.



69
70
71
 
# File 'lib/tripletex_api/models/invoice.rb', line 69

def amount_roundoff_currency
  @amount_roundoff_currency
end

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#comment ⇒ Object

Returns the value of attribute comment.



39
40
41
 
# File 'lib/tripletex_api/models/invoice.rb', line 39

def comment
  @comment
end

#currency ⇒ Object

Returns the value of attribute currency.



80
81
82
 
# File 'lib/tripletex_api/models/invoice.rb', line 80

def currency
  @currency
end

#customer ⇒ Object

The invoice customer



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

def customer
  @customer
end

#delivery_date ⇒ Object

The delivery date.



51
52
53
 
# File 'lib/tripletex_api/models/invoice.rb', line 51

def delivery_date
  @delivery_date
end

#ehf_send_status ⇒ Object

Returns the value of attribute ehf_send_status.



90
91
92
 
# File 'lib/tripletex_api/models/invoice.rb', line 90

def ehf_send_status
  @ehf_send_status
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#invoice_date ⇒ Object

Returns the value of attribute invoice_date.



29
30
31
 
# File 'lib/tripletex_api/models/invoice.rb', line 29

def invoice_date
  @invoice_date
end

#invoice_due_date ⇒ Object

Returns the value of attribute invoice_due_date.



34
35
36
 
# File 'lib/tripletex_api/models/invoice.rb', line 34

def invoice_due_date
  @invoice_due_date
end

#invoice_number ⇒ Object

If value is set to 0, the invoice number will be generated.



27
28
29
 
# File 'lib/tripletex_api/models/invoice.rb', line 27

def invoice_number
  @invoice_number
end

#is_credit_note ⇒ Object

Returns the value of attribute is_credit_note.



82
83
84
 
# File 'lib/tripletex_api/models/invoice.rb', line 82

def is_credit_note
  @is_credit_note
end

#kid ⇒ Object

KID - Kundeidentifikasjonsnummer.



37
38
39
 
# File 'lib/tripletex_api/models/invoice.rb', line 37

def kid
  @kid
end

#orders ⇒ Object

Related orders. Only one order per invoice is supported at the moment.



42
43
44
 
# File 'lib/tripletex_api/models/invoice.rb', line 42

def orders
  @orders
end

#postings ⇒ Object

The invoice postings, which includes a posting for the invoice with a positive amount, and one or more posting for the payments with negative amounts.



85
86
87
 
# File 'lib/tripletex_api/models/invoice.rb', line 85

def postings
  @postings
end

#project_invoice_details ⇒ Object

ProjectInvoiceDetails contains additional information about the invoice, in particular invoices for projects. It contains information about the charged project, the fee amount, extra percent and amount, extra costs, travel expenses, invoice and project comments, akonto amount and values determining if extra costs, akonto and hours should be included. ProjectInvoiceDetails is an object which represents the relation between an invoice and a Project, Orderline and OrderOut object.



45
46
47
 
# File 'lib/tripletex_api/models/invoice.rb', line 45

def project_invoice_details
  @project_invoice_details
end

#reminders ⇒ Object

Invoice debt collection and reminders.



88
89
90
 
# File 'lib/tripletex_api/models/invoice.rb', line 88

def reminders
  @reminders
end

#sum_remits ⇒ Object

The sum of all open remittances of the invoice. Remittances are reimbursement payments back to the customer and are therefore relevant to the bookkeeping of the invoice in the accounts.



78
79
80
 
# File 'lib/tripletex_api/models/invoice.rb', line 78

def sum_remits
  @sum_remits
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

#voucher ⇒ Object

The invoice voucher.



48
49
50
 
# File 'lib/tripletex_api/models/invoice.rb', line 48

def voucher
  @voucher
end

Class Method Details

.attribute_map ⇒ Object

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



115
116
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
 
# File 'lib/tripletex_api/models/invoice.rb', line 115

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'invoice_number' => :'invoiceNumber',
    :'invoice_date' => :'invoiceDate',
    :'customer' => :'customer',
    :'invoice_due_date' => :'invoiceDueDate',
    :'kid' => :'kid',
    :'comment' => :'comment',
    :'orders' => :'orders',
    :'project_invoice_details' => :'projectInvoiceDetails',
    :'voucher' => :'voucher',
    :'delivery_date' => :'deliveryDate',
    :'amount' => :'amount',
    :'amount_currency' => :'amountCurrency',
    :'amount_excluding_vat' => :'amountExcludingVat',
    :'amount_excluding_vat_currency' => :'amountExcludingVatCurrency',
    :'amount_roundoff' => :'amountRoundoff',
    :'amount_roundoff_currency' => :'amountRoundoffCurrency',
    :'amount_outstanding' => :'amountOutstanding',
    :'amount_outstanding_total' => :'amountOutstandingTotal',
    :'sum_remits' => :'sumRemits',
    :'currency' => :'currency',
    :'is_credit_note' => :'isCreditNote',
    :'postings' => :'postings',
    :'reminders' => :'reminders',
    :'ehf_send_status' => :'ehfSendStatus'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'invoice_number' => :'Integer',
    :'invoice_date' => :'String',
    :'customer' => :'Customer',
    :'invoice_due_date' => :'String',
    :'kid' => :'String',
    :'comment' => :'String',
    :'orders' => :'Array<Order>',
    :'project_invoice_details' => :'Array<ProjectInvoiceDetails>',
    :'voucher' => :'Voucher',
    :'delivery_date' => :'String',
    :'amount' => :'Float',
    :'amount_currency' => :'Float',
    :'amount_excluding_vat' => :'Float',
    :'amount_excluding_vat_currency' => :'Float',
    :'amount_roundoff' => :'Float',
    :'amount_roundoff_currency' => :'Float',
    :'amount_outstanding' => :'Float',
    :'amount_outstanding_total' => :'Float',
    :'sum_remits' => :'Float',
    :'currency' => :'Currency',
    :'is_credit_note' => :'BOOLEAN',
    :'postings' => :'Array<Posting>',
    :'reminders' => :'Array<Reminder>',
    :'ehf_send_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/tripletex_api/models/invoice.rb', line 390

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 &&
      customer == o.customer &&
      invoice_due_date == o.invoice_due_date &&
      kid == o.kid &&
      comment == o.comment &&
      orders == o.orders &&
      project_invoice_details == o.project_invoice_details &&
      voucher == o.voucher &&
      delivery_date == o.delivery_date &&
      amount == o.amount &&
      amount_currency == o.amount_currency &&
      amount_excluding_vat == o.amount_excluding_vat &&
      amount_excluding_vat_currency == o.amount_excluding_vat_currency &&
      amount_roundoff == o.amount_roundoff &&
      amount_roundoff_currency == o.amount_roundoff_currency &&
      amount_outstanding == o.amount_outstanding &&
      amount_outstanding_total == o.amount_outstanding_total &&
      sum_remits == o.sum_remits &&
      currency == o.currency &&
      is_credit_note == o.is_credit_note &&
      postings == o.postings &&
      reminders == o.reminders &&
      ehf_send_status == o.ehf_send_status
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



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
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/tripletex_api/models/invoice.rb', line 459

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



525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/tripletex_api/models/invoice.rb', line 525

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



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/tripletex_api/models/invoice.rb', line 438

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


425
426
427
 
# File 'lib/tripletex_api/models/invoice.rb', line 425

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



431
432
433
 
# File 'lib/tripletex_api/models/invoice.rb', line 431

def hash
  [id, version, changes, url, invoice_number, invoice_date, customer, invoice_due_date, kid, comment, orders, project_invoice_details, voucher, delivery_date, amount, amount_currency, amount_excluding_vat, amount_excluding_vat_currency, amount_roundoff, amount_roundoff_currency, amount_outstanding, amount_outstanding_total, sum_remits, currency, is_credit_note, postings, reminders, ehf_send_status].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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/tripletex_api/models/invoice.rb', line 318

def list_invalid_properties
  invalid_properties = Array.new
  if !@invoice_number.nil? && @invoice_number < 0
    invalid_properties.push("invalid value for 'invoice_number', must be greater than or equal to 0.")
  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 !@kid.nil? && @kid.to_s.length > 25
    invalid_properties.push("invalid value for 'kid', the character length must be smaller than or equal to 25.")
  end

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



505
506
507
 
# File 'lib/tripletex_api/models/invoice.rb', line 505

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



511
512
513
514
515
516
517
518
519
 
# File 'lib/tripletex_api/models/invoice.rb', line 511

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



499
500
501
 
# File 'lib/tripletex_api/models/invoice.rb', line 499

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



345
346
347
348
349
350
351
352
353
354
 
# File 'lib/tripletex_api/models/invoice.rb', line 345

def valid?
  return false if !@invoice_number.nil? && @invoice_number < 0
  return false if @invoice_date.nil?
  return false if @invoice_due_date.nil?
  return false if !@kid.nil? && @kid.to_s.length > 25
  return false if @orders.nil?
  ehf_send_status_validator = EnumAttributeValidator.new('String', ["DO_NOT_SEND", "SEND", "SENT", "SEND_FAILURE_RECIPIENT_NOT_FOUND"])
  return false unless ehf_send_status_validator.valid?(@ehf_send_status)
  return true
end