Class: TripletexRubyClient::HistoricalVoucher

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HistoricalVoucher

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 80

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?(:'externalVoucherNumber')
    self.external_voucher_number = attributes[:'externalVoucherNumber']
  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?(:'postings')
    if (value = attributes[:'postings']).is_a?(Array)
      self.postings = value
    end
  end
end

Instance Attribute Details

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#date ⇒ Object

The voucher date.



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

def date
  @date
end

#description ⇒ Object

The voucher description.



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

def description
  @description
end

#external_voucher_number ⇒ Object

External voucher number. This is the voucher number in the historical system.



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

def external_voucher_number
  @external_voucher_number
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#number ⇒ Object

The voucher number generated by Tripletex. System generated number that cannot be changed.



30
31
32
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 30

def number
  @number
end

#postings ⇒ Object

The list of postings of the voucher. In postings, these fields must be provided: date, account, currency, amount, amountBasis, amountVat, amountCurrency, amountBasisCurrency.



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

def postings
  @postings
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

#voucher_type ⇒ Object

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



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

def voucher_type
  @voucher_type
end

#year ⇒ Object

Voucher year. System generated number that cannot be changed.



33
34
35
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 33

def year
  @year
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 45

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'date' => :'date',
    :'external_voucher_number' => :'externalVoucherNumber',
    :'number' => :'number',
    :'year' => :'year',
    :'description' => :'description',
    :'voucher_type' => :'voucherType',
    :'postings' => :'postings'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 62

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'date' => :'String',
    :'external_voucher_number' => :'String',
    :'number' => :'Integer',
    :'year' => :'Integer',
    :'description' => :'String',
    :'voucher_type' => :'VoucherType',
    :'postings' => :'Array<HistoricalPosting>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 200

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 &&
      external_voucher_number == o.external_voucher_number &&
      number == o.number &&
      year == o.year &&
      description == o.description &&
      voucher_type == o.voucher_type &&
      postings == o.postings
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



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

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 318

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 231

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


218
219
220
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



224
225
226
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 224

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



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

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

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

  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



298
299
300
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 298

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



304
305
306
307
308
309
310
311
312
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 304

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



292
293
294
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 292

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



168
169
170
171
172
173
174
175
176
 
# File 'lib/tripletex_ruby_client/models/historical_voucher.rb', line 168

def valid?
  return false if @date.nil?
  return false if @external_voucher_number.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?
  true
end