Class: TripletexApi::Voucher

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Voucher

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
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
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
 
# File 'lib/tripletex_api/models/voucher.rb', line 95

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#attachment ⇒ Object

If the documentation for the voucher has been provided from an external source (e.g. another system via API or a user upload) then this is a reference to the document. This is always a PDF. Note that a voucher may have both a document, an attachment and an ediDocument.



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

def attachment
  @attachment
end

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#date ⇒ Object

Returns the value of attribute date.



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

def date
  @date
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#document ⇒ Object

If the documentation for the voucher has been generated by the system (e.g. an invoice) then this is a reference to the generated document. This document is always a PDF. Note that a voucher may have both a document, an attachment and an ediDocument.



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

def document
  @document
end

#edi_document ⇒ Object

If the voucher is created based on a machine readable document (such as EHF or EFO/NELFO) then this is a reference to that document. Note that a voucher may have both a document, an attachment and an ediDocument.



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

def edi_document
  @edi_document
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#number ⇒ Object

System generated number that cannot be changed.



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

def number
  @number
end

#postings ⇒ Object

Returns the value of attribute postings.



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

def postings
  @postings
end

#reverse_voucher ⇒ Object

Returns the value of attribute reverse_voucher.



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

def reverse_voucher
  @reverse_voucher
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

#voucher_type ⇒ Object

Voucher type. Must not be of type ‘Utgående faktura’ (‘Outgoing Invoice’) on new vouchers, instead use voucherType=null or use the Invoice endpoint.



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

def voucher_type
  @voucher_type
end

#year ⇒ Object

System generated number that cannot be changed.



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

def year
  @year
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/tripletex_api/models/voucher.rb', line 54

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'date' => :'date',
    :'number' => :'number',
    :'year' => :'year',
    :'description' => :'description',
    :'voucher_type' => :'voucherType',
    :'reverse_voucher' => :'reverseVoucher',
    :'postings' => :'postings',
    :'document' => :'document',
    :'attachment' => :'attachment',
    :'edi_document' => :'ediDocument'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/tripletex_api/models/voucher.rb', line 74

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'date' => :'String',
    :'number' => :'Integer',
    :'year' => :'Integer',
    :'description' => :'String',
    :'voucher_type' => :'VoucherType',
    :'reverse_voucher' => :'Voucher',
    :'postings' => :'Array<Posting>',
    :'document' => :'Document',
    :'attachment' => :'Document',
    :'edi_document' => :'Document'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/tripletex_api/models/voucher.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      date == o.date &&
      number == o.number &&
      year == o.year &&
      description == o.description &&
      voucher_type == o.voucher_type &&
      reverse_voucher == o.reverse_voucher &&
      postings == o.postings &&
      document == o.document &&
      attachment == o.attachment &&
      edi_document == o.edi_document
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



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
315
316
 
# File 'lib/tripletex_api/models/voucher.rb', line 280

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/tripletex_api/models/voucher.rb', line 346

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/tripletex_api/models/voucher.rb', line 259

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


246
247
248
 
# File 'lib/tripletex_api/models/voucher.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



252
253
254
 
# File 'lib/tripletex_api/models/voucher.rb', line 252

def hash
  [id, version, changes, url, date, number, year, description, voucher_type, reverse_voucher, postings, document, attachment, edi_document].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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/tripletex_api/models/voucher.rb', line 165

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

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

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

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

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



326
327
328
 
# File 'lib/tripletex_api/models/voucher.rb', line 326

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



332
333
334
335
336
337
338
339
340
 
# File 'lib/tripletex_api/models/voucher.rb', line 332

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



320
321
322
 
# File 'lib/tripletex_api/models/voucher.rb', line 320

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



192
193
194
195
196
197
198
199
 
# File 'lib/tripletex_api/models/voucher.rb', line 192

def valid?
  return false if @date.nil?
  return false if !@number.nil? && @number < 0
  return false if !@year.nil? && @year < 0
  return false if @description.nil?
  return false if @postings.nil?
  return true
end