Class: TripletexApi::ProjectInvoiceDetails

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProjectInvoiceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#amount_order_lines_and_reinvoicing ⇒ Object

The amount of chargeable manual order lines and vendor invoices on the project invoice.



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

def amount_order_lines_and_reinvoicing
  @amount_order_lines_and_reinvoicing
end

#amount_order_lines_and_reinvoicing_currency ⇒ Object

The amount of chargeable manual order lines and vendor invoices on the project invoice, in the invoice currency.



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

def amount_order_lines_and_reinvoicing_currency
  @amount_order_lines_and_reinvoicing_currency
end

#amount_travel_reports_and_expenses ⇒ Object

The amount of travel costs and expenses on the project invoice.



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

def amount_travel_reports_and_expenses
  @amount_travel_reports_and_expenses
end

#amount_travel_reports_and_expenses_currency ⇒ Object

The amount of travel costs and expenses on the project invoice, in the invoice currency.



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

def amount_travel_reports_and_expenses_currency
  @amount_travel_reports_and_expenses_currency
end

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#fee_amount ⇒ Object

Fee amount of the project. For example: 100 NOK.



30
31
32
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 30

def fee_amount
  @fee_amount
end

#fee_amount_currency ⇒ Object

Fee amount of the project in the invoice currency.



33
34
35
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 33

def fee_amount_currency
  @fee_amount_currency
end

#fee_invoice_text ⇒ Object

The fee comment on the project invoice.



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

def fee_invoice_text
  @fee_invoice_text
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#include_hours ⇒ Object

Determines if hours should be included on the project invoice.



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

def include_hours
  @include_hours
end

#include_on_account_balance ⇒ Object

Determines if akonto should be included on the project invoice.



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

def 
  @include_on_account_balance
end

#include_order_lines_and_reinvoicing ⇒ Object

Determines if extra costs should be included on the project invoice.



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

def include_order_lines_and_reinvoicing
  @include_order_lines_and_reinvoicing
end

#invoice_text ⇒ Object

The comment on the project invoice.



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

def invoice_text
  @invoice_text
end

#markup_amount ⇒ Object

The amount value of mark-up of amountFee on the project invoice. For example: 10 NOK.



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

def markup_amount
  @markup_amount
end

#markup_amount_currency ⇒ Object

The amount value of mark-up of amountFee on the project invoice, in the invoice currency.



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

def markup_amount_currency
  @markup_amount_currency
end

#markup_percent ⇒ Object

The percentage value of mark-up of amountFee. For example: 10%.



36
37
38
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 36

def markup_percent
  @markup_percent
end

#on_account_balance_amount ⇒ Object

The akonto amount on the project invoice.



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

def 
  @on_account_balance_amount
end

#on_account_balance_amount_currency ⇒ Object

The akonto amount on the project invoice in the invoice currency.



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

def 
  @on_account_balance_amount_currency
end

#project ⇒ Object

The Project related to the Invoice and ProjectInvoiceAdditionalInfo.



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

def project
  @project
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

#vat_type ⇒ Object

The VAT type of the project invoice.



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

def vat_type
  @vat_type
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'project' => :'project',
    :'fee_amount' => :'feeAmount',
    :'fee_amount_currency' => :'feeAmountCurrency',
    :'markup_percent' => :'markupPercent',
    :'markup_amount' => :'markupAmount',
    :'markup_amount_currency' => :'markupAmountCurrency',
    :'amount_order_lines_and_reinvoicing' => :'amountOrderLinesAndReinvoicing',
    :'amount_order_lines_and_reinvoicing_currency' => :'amountOrderLinesAndReinvoicingCurrency',
    :'amount_travel_reports_and_expenses' => :'amountTravelReportsAndExpenses',
    :'amount_travel_reports_and_expenses_currency' => :'amountTravelReportsAndExpensesCurrency',
    :'fee_invoice_text' => :'feeInvoiceText',
    :'invoice_text' => :'invoiceText',
    :'include_order_lines_and_reinvoicing' => :'includeOrderLinesAndReinvoicing',
    :'include_hours' => :'includeHours',
    :'include_on_account_balance' => :'includeOnAccountBalance',
    :'on_account_balance_amount' => :'onAccountBalanceAmount',
    :'on_account_balance_amount_currency' => :'onAccountBalanceAmountCurrency',
    :'vat_type' => :'vatType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'project' => :'Project',
    :'fee_amount' => :'Float',
    :'fee_amount_currency' => :'Float',
    :'markup_percent' => :'Float',
    :'markup_amount' => :'Float',
    :'markup_amount_currency' => :'Float',
    :'amount_order_lines_and_reinvoicing' => :'Float',
    :'amount_order_lines_and_reinvoicing_currency' => :'Float',
    :'amount_travel_reports_and_expenses' => :'Float',
    :'amount_travel_reports_and_expenses_currency' => :'Float',
    :'fee_invoice_text' => :'String',
    :'invoice_text' => :'String',
    :'include_order_lines_and_reinvoicing' => :'BOOLEAN',
    :'include_hours' => :'BOOLEAN',
    :'include_on_account_balance' => :'BOOLEAN',
    :'on_account_balance_amount' => :'Float',
    :'on_account_balance_amount_currency' => :'Float',
    :'vat_type' => :'VatType'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      project == o.project &&
      fee_amount == o.fee_amount &&
      fee_amount_currency == o.fee_amount_currency &&
      markup_percent == o.markup_percent &&
      markup_amount == o.markup_amount &&
      markup_amount_currency == o.markup_amount_currency &&
      amount_order_lines_and_reinvoicing == o.amount_order_lines_and_reinvoicing &&
      amount_order_lines_and_reinvoicing_currency == o.amount_order_lines_and_reinvoicing_currency &&
      amount_travel_reports_and_expenses == o.amount_travel_reports_and_expenses &&
      amount_travel_reports_and_expenses_currency == o.amount_travel_reports_and_expenses_currency &&
      fee_invoice_text == o.fee_invoice_text &&
      invoice_text == o.invoice_text &&
      include_order_lines_and_reinvoicing == o.include_order_lines_and_reinvoicing &&
      include_hours == o.include_hours &&
       == o. &&
       == o. &&
       == o. &&
      vat_type == o.vat_type
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



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
365
366
367
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 331

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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 397

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 310

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


297
298
299
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 303

def hash
  [id, version, changes, url, project, fee_amount, fee_amount_currency, markup_percent, markup_amount, markup_amount_currency, amount_order_lines_and_reinvoicing, amount_order_lines_and_reinvoicing_currency, amount_travel_reports_and_expenses, amount_travel_reports_and_expenses_currency, fee_invoice_text, invoice_text, include_order_lines_and_reinvoicing, include_hours, , , , vat_type].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



245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 245

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

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



377
378
379
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 377

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



383
384
385
386
387
388
389
390
391
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 383

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



371
372
373
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 371

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



260
261
262
263
264
 
# File 'lib/tripletex_api/models/project_invoice_details.rb', line 260

def valid?
  return false if @fee_invoice_text.nil?
  return false if @invoice_text.nil?
  return true
end