Class: TripletexApi::PaymentTypeOut

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentTypeOut

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/tripletex_api/models/payment_type_out.rb', line 97

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#changesObject

Returns the value of attribute changes.



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

def changes
  @changes
end

#credit_accountObject

Returns the value of attribute credit_account.



31
32
33
# File 'lib/tripletex_api/models/payment_type_out.rb', line 31

def 
  @credit_account
end

#descriptionObject

Returns the value of attribute description.



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

def description
  @description
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#is_brutto_wage_deductionObject

true if it should be a deduction from the wage. The module PROVISIONSALARY is required to both view and change this setting



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

def is_brutto_wage_deduction
  @is_brutto_wage_deduction
end

#is_inactiveObject

true if the payment type should be hidden from available payment types



52
53
54
# File 'lib/tripletex_api/models/payment_type_out.rb', line 52

def is_inactive
  @is_inactive
end

#requires_separate_voucherObject

true if a separate voucher is required



46
47
48
# File 'lib/tripletex_api/models/payment_type_out.rb', line 46

def requires_separate_voucher
  @requires_separate_voucher
end

#sequenceObject

determines in which order the types should be listed. No 1 is listed first



49
50
51
# File 'lib/tripletex_api/models/payment_type_out.rb', line 49

def sequence
  @sequence
end

#show_incoming_invoiceObject

true if the payment type should be available in supplier invoices



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

def show_incoming_invoice
  @show_incoming_invoice
end

#show_vat_returnsObject

true if the payment type should be available in vat returns



40
41
42
# File 'lib/tripletex_api/models/payment_type_out.rb', line 40

def show_vat_returns
  @show_vat_returns
end

#show_wage_paymentObject

true if the payment type should be available in wage payments. The wage module is required to both view and change this setting



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

def show_wage_payment
  @show_wage_payment
end

#show_wage_period_transactionObject

true if the payment type should be available in period transactionsThe wage module is required to both view and change this setting



43
44
45
# File 'lib/tripletex_api/models/payment_type_out.rb', line 43

def show_wage_period_transaction
  @show_wage_period_transaction
end

#urlObject

Returns the value of attribute url.



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

def url
  @url
end

#versionObject

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'description' => :'description',
    :'is_brutto_wage_deduction' => :'isBruttoWageDeduction',
    :'credit_account' => :'creditAccount',
    :'show_incoming_invoice' => :'showIncomingInvoice',
    :'show_wage_payment' => :'showWagePayment',
    :'show_vat_returns' => :'showVatReturns',
    :'show_wage_period_transaction' => :'showWagePeriodTransaction',
    :'requires_separate_voucher' => :'requiresSeparateVoucher',
    :'sequence' => :'sequence',
    :'is_inactive' => :'isInactive'
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'description' => :'String',
    :'is_brutto_wage_deduction' => :'BOOLEAN',
    :'credit_account' => :'Account',
    :'show_incoming_invoice' => :'BOOLEAN',
    :'show_wage_payment' => :'BOOLEAN',
    :'show_vat_returns' => :'BOOLEAN',
    :'show_wage_period_transaction' => :'BOOLEAN',
    :'requires_separate_voucher' => :'BOOLEAN',
    :'sequence' => :'Integer',
    :'is_inactive' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/tripletex_api/models/payment_type_out.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      description == o.description &&
      is_brutto_wage_deduction == o.is_brutto_wage_deduction &&
       == o. &&
      show_incoming_invoice == o.show_incoming_invoice &&
      show_wage_payment == o.show_wage_payment &&
      show_vat_returns == o.show_vat_returns &&
      show_wage_period_transaction == o.show_wage_period_transaction &&
      requires_separate_voucher == o.requires_separate_voucher &&
      sequence == o.sequence &&
      is_inactive == o.is_inactive
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



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

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



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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/tripletex_api/models/payment_type_out.rb', line 255

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


242
243
244
# File 'lib/tripletex_api/models/payment_type_out.rb', line 242

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



248
249
250
# File 'lib/tripletex_api/models/payment_type_out.rb', line 248

def hash
  [id, version, changes, url, description, is_brutto_wage_deduction, , show_incoming_invoice, show_wage_payment, show_vat_returns, show_wage_period_transaction, requires_separate_voucher, sequence, is_inactive].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/tripletex_api/models/payment_type_out.rb', line 179

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

  if @description.to_s.length > 255
    invalid_properties.push("invalid value for 'description', the character length must be smaller than or equal to 255.")
  end

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

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



322
323
324
# File 'lib/tripletex_api/models/payment_type_out.rb', line 322

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



328
329
330
331
332
333
334
335
336
# File 'lib/tripletex_api/models/payment_type_out.rb', line 328

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



316
317
318
# File 'lib/tripletex_api/models/payment_type_out.rb', line 316

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



198
199
200
201
202
203
# File 'lib/tripletex_api/models/payment_type_out.rb', line 198

def valid?
  return false if @description.nil?
  return false if @description.to_s.length > 255
  return false if @credit_account.nil?
  return true
end