Class: IntegrationApi::Invoice

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

Overview

Invoice Object

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#business_id ⇒ Object

businessId



19
20
21
 
# File 'lib/integration_api/models/invoice.rb', line 19

def business_id
  @business_id
end

#client_id ⇒ Object

client_id



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

def client_id
  @client_id
end

#contact_id ⇒ Object

contact_id



25
26
27
 
# File 'lib/integration_api/models/invoice.rb', line 25

def contact_id
  @contact_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



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

def create_date
  @create_date
end

#currency_code ⇒ Object

currency_code



30
31
32
 
# File 'lib/integration_api/models/invoice.rb', line 30

def currency_code
  @currency_code
end

#department ⇒ Object

department



33
34
35
 
# File 'lib/integration_api/models/invoice.rb', line 33

def department
  @department
end

#description ⇒ Object

description



36
37
38
 
# File 'lib/integration_api/models/invoice.rb', line 36

def description
  @description
end

#document_id ⇒ Object

document_id



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

def document_id
  @document_id
end

#due_date ⇒ Object

due_date



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

def due_date
  @due_date
end

#id ⇒ Object

Returns the value of attribute id.



44
45
46
 
# File 'lib/integration_api/models/invoice.rb', line 44

def id
  @id
end

#invoice_date ⇒ Object

invoice_date



47
48
49
 
# File 'lib/integration_api/models/invoice.rb', line 47

def invoice_date
  @invoice_date
end

#invoice_name ⇒ Object

invoice_name



50
51
52
 
# File 'lib/integration_api/models/invoice.rb', line 50

def invoice_name
  @invoice_name
end

#invoice_number ⇒ Object

invoice_number



53
54
55
 
# File 'lib/integration_api/models/invoice.rb', line 53

def invoice_number
  @invoice_number
end

#is_active ⇒ Object

is_active



56
57
58
 
# File 'lib/integration_api/models/invoice.rb', line 56

def is_active
  @is_active
end

#is_bill ⇒ Object

is_bill



59
60
61
 
# File 'lib/integration_api/models/invoice.rb', line 59

def is_bill
  @is_bill
end

#line_items ⇒ Object

lineItems



62
63
64
 
# File 'lib/integration_api/models/invoice.rb', line 62

def line_items
  @line_items
end

#metadata ⇒ Object

Returns the value of attribute metadata.



64
65
66
 
# File 'lib/integration_api/models/invoice.rb', line 64

def metadata
  @metadata
end

#payment_instructions ⇒ Object

paymentInstructions



67
68
69
 
# File 'lib/integration_api/models/invoice.rb', line 67

def payment_instructions
  @payment_instructions
end

#payment_terms ⇒ Object

paymentTerms



70
71
72
 
# File 'lib/integration_api/models/invoice.rb', line 70

def payment_terms
  @payment_terms
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



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

def secondary_id
  @secondary_id
end

#status ⇒ Object

status



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

def status
  @status
end

#total_amount ⇒ Object

totalAmount



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

def total_amount
  @total_amount
end

#total_discount ⇒ Object

totalDiscount



81
82
83
 
# File 'lib/integration_api/models/invoice.rb', line 81

def total_discount
  @total_discount
end

#total_due ⇒ Object

totalDue



84
85
86
 
# File 'lib/integration_api/models/invoice.rb', line 84

def total_due
  @total_due
end

#total_subtotal ⇒ Object

totalSubtotal



87
88
89
 
# File 'lib/integration_api/models/invoice.rb', line 87

def total_subtotal
  @total_subtotal
end

#total_tax ⇒ Object

totalTax



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

def total_tax
  @total_tax
end

#update_date ⇒ Object

Returns the value of attribute update_date.



92
93
94
 
# File 'lib/integration_api/models/invoice.rb', line 92

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'business_id' => :'business_id',
    :'client_id' => :'client_id',
    :'contact_id' => :'contact_id',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'department' => :'department',
    :'description' => :'description',
    :'document_id' => :'document_id',
    :'due_date' => :'due_date',
    :'id' => :'id',
    :'invoice_date' => :'invoice_date',
    :'invoice_name' => :'invoice_name',
    :'invoice_number' => :'invoice_number',
    :'is_active' => :'is_active',
    :'is_bill' => :'is_bill',
    :'line_items' => :'line_items',
    :'metadata' => :'metadata',
    :'payment_instructions' => :'payment_instructions',
    :'payment_terms' => :'payment_terms',
    :'secondary_id' => :'secondary_id',
    :'status' => :'status',
    :'total_amount' => :'total_amount',
    :'total_discount' => :'total_discount',
    :'total_due' => :'total_due',
    :'total_subtotal' => :'total_subtotal',
    :'total_tax' => :'total_tax',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'business_id' => :'String',
    :'client_id' => :'String',
    :'contact_id' => :'String',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'department' => :'String',
    :'description' => :'String',
    :'document_id' => :'String',
    :'due_date' => :'DateTime',
    :'id' => :'String',
    :'invoice_date' => :'DateTime',
    :'invoice_name' => :'String',
    :'invoice_number' => :'String',
    :'is_active' => :'BOOLEAN',
    :'is_bill' => :'BOOLEAN',
    :'line_items' => :'Array<LineItems>',
    :'metadata' => :'Hash<String, String>',
    :'payment_instructions' => :'String',
    :'payment_terms' => :'String',
    :'secondary_id' => :'String',
    :'status' => :'String',
    :'total_amount' => :'Float',
    :'total_discount' => :'Float',
    :'total_due' => :'Float',
    :'total_subtotal' => :'Float',
    :'total_tax' => :'Float',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



326
327
328
329
330
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
 
# File 'lib/integration_api/models/invoice.rb', line 326

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      business_id == o.business_id &&
      client_id == o.client_id &&
      contact_id == o.contact_id &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      department == o.department &&
      description == o.description &&
      document_id == o.document_id &&
      due_date == o.due_date &&
      id == o.id &&
      invoice_date == o.invoice_date &&
      invoice_name == o.invoice_name &&
      invoice_number == o.invoice_number &&
      is_active == o.is_active &&
      is_bill == o.is_bill &&
      line_items == o.line_items &&
      metadata == o.metadata &&
      payment_instructions == o.payment_instructions &&
      payment_terms == o.payment_terms &&
      secondary_id == o.secondary_id &&
      status == o.status &&
      total_amount == o.total_amount &&
      total_discount == o.total_discount &&
      total_due == o.total_due &&
      total_subtotal == o.total_subtotal &&
      total_tax == o.total_tax &&
      update_date == o.update_date
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



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
422
423
424
425
426
427
428
429
 
# File 'lib/integration_api/models/invoice.rb', line 393

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    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 = IntegrationApi.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



457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/integration_api/models/invoice.rb', line 457

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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/integration_api/models/invoice.rb', line 373

def build_from_hash(attributes)
  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


360
361
362
 
# File 'lib/integration_api/models/invoice.rb', line 360

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



366
367
368
 
# File 'lib/integration_api/models/invoice.rb', line 366

def hash
  [business_id, client_id, contact_id, create_date, currency_code, department, description, document_id, due_date, id, invoice_date, invoice_name, invoice_number, is_active, is_bill, line_items, metadata, payment_instructions, payment_terms, secondary_id, status, total_amount, total_discount, total_due, total_subtotal, total_tax, update_date].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



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

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

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

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

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

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

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



438
439
440
 
# File 'lib/integration_api/models/invoice.rb', line 438

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



444
445
446
447
448
449
450
451
 
# File 'lib/integration_api/models/invoice.rb', line 444

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



432
433
434
 
# File 'lib/integration_api/models/invoice.rb', line 432

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



314
315
316
317
318
319
320
321
322
 
# File 'lib/integration_api/models/invoice.rb', line 314

def valid?
  return false if @contact_id.nil?
  return false if @currency_code.nil?
  return false if @due_date.nil?
  return false if @invoice_date.nil?
  return false if @invoice_number.nil?
  return false if @total_amount.nil?
  true
end