Class: XeroRuby::Accounting::CreditNote

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/credit_note.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

ACCPAYCREDIT =
"ACCPAYCREDIT".freeze
ACCRECCREDIT =
"ACCRECCREDIT".freeze
DRAFT =
"DRAFT".freeze
SUBMITTED =
"SUBMITTED".freeze
DELETED =
"DELETED".freeze
AUTHORISED =
"AUTHORISED".freeze
"PAID".freeze
VOIDED =
"VOIDED".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditNote

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
317
318
319
320
321
322
323
324
325
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
357
358
359
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 213

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::CreditNote` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Accounting::CreditNote`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'contact')
    self.contact = attributes[:'contact']
  end

  if attributes.key?(:'date')
    self.date = attributes[:'date']
  end

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

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

  if attributes.key?(:'line_amount_types')
    self.line_amount_types = attributes[:'line_amount_types']
  end

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

  if attributes.key?(:'sub_total')
    self.sub_total = attributes[:'sub_total']
  end

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

  if attributes.key?(:'total')
    self.total = attributes[:'total']
  end

  if attributes.key?(:'cis_deduction')
    self.cis_deduction = attributes[:'cis_deduction']
  end

  if attributes.key?(:'cis_rate')
    self.cis_rate = attributes[:'cis_rate']
  end

  if attributes.key?(:'updated_date_utc')
    self.updated_date_utc = attributes[:'updated_date_utc']
  end

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

  if attributes.key?(:'fully_paid_on_date')
    self.fully_paid_on_date = attributes[:'fully_paid_on_date']
  end

  if attributes.key?(:'credit_note_id')
    self.credit_note_id = attributes[:'credit_note_id']
  end

  if attributes.key?(:'credit_note_number')
    self.credit_note_number = attributes[:'credit_note_number']
  end

  if attributes.key?(:'reference')
    self.reference = attributes[:'reference']
  end

  if attributes.key?(:'sent_to_contact')
    self.sent_to_contact = attributes[:'sent_to_contact']
  end

  if attributes.key?(:'currency_rate')
    self.currency_rate = attributes[:'currency_rate']
  end

  if attributes.key?(:'remaining_credit')
    self.remaining_credit = attributes[:'remaining_credit']
  end

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

  if attributes.key?(:'applied_amount')
    self.applied_amount = attributes[:'applied_amount']
  end

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

  if attributes.key?(:'branding_theme_id')
    self.branding_theme_id = attributes[:'branding_theme_id']
  end

  if attributes.key?(:'status_attribute_string')
    self.status_attribute_string = attributes[:'status_attribute_string']
  end

  if attributes.key?(:'has_attachments')
    self.has_attachments = attributes[:'has_attachments']
  else
    self.has_attachments = false
  end

  if attributes.key?(:'has_errors')
    self.has_errors = attributes[:'has_errors']
  else
    self.has_errors = false
  end

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

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

Instance Attribute Details

#allocationsObject

See Allocations


91
92
93
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 91

def allocations
  @allocations
end

#applied_amountObject

The amount of applied to an invoice


94
95
96
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 94

def applied_amount
  @applied_amount
end

#branding_theme_idObject

See BrandingThemes


100
101
102
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 100

def branding_theme_id
  @branding_theme_id
end

#cis_deductionObject

CIS deduction for UK contractors


58
59
60
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 58

def cis_deduction
  @cis_deduction
end

#cis_rateObject

CIS Deduction rate for the organisation


61
62
63
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 61

def cis_rate
  @cis_rate
end

#contactObject

Returns the value of attribute contact


25
26
27
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 25

def contact
  @contact
end

#credit_note_idObject

Xero generated unique identifier


73
74
75
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 73

def credit_note_id
  @credit_note_id
end

#credit_note_numberObject

ACCRECCREDIT – Unique alpha numeric code identifying credit note (when missing will auto-generate from your Organisation Invoice Settings)


76
77
78
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 76

def credit_note_number
  @credit_note_number
end

#currency_codeObject

Returns the value of attribute currency_code


67
68
69
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 67

def currency_code
  @currency_code
end

#currency_rateObject

The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used


85
86
87
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 85

def currency_rate
  @currency_rate
end

#dateObject

The date the credit note is issued YYYY-MM-DD. If the Date element is not specified then it will default to the current date based on the timezone setting of the organisation


28
29
30
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 28

def date
  @date
end

#due_dateObject

Date invoice is due – YYYY-MM-DD


31
32
33
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 31

def due_date
  @due_date
end

#fully_paid_on_dateObject

Date when credit note was fully paid(UTC format)


70
71
72
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 70

def fully_paid_on_date
  @fully_paid_on_date
end

#has_attachmentsObject

boolean to indicate if a credit note has an attachment


106
107
108
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 106

def has_attachments
  @has_attachments
end

#has_errorsObject

A boolean to indicate if a credit note has an validation errors


109
110
111
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 109

def has_errors
  @has_errors
end

#line_amount_typesObject

Returns the value of attribute line_amount_types


43
44
45
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 43

def line_amount_types
  @line_amount_types
end

#line_itemsObject

See Invoice Line Items


46
47
48
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 46

def line_items
  @line_items
end

#paymentsObject

See Payments


97
98
99
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 97

def payments
  @payments
end

#referenceObject

ACCRECCREDIT only – additional reference number


79
80
81
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 79

def reference
  @reference
end

#remaining_creditObject

The remaining credit balance on the Credit Note


88
89
90
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 88

def remaining_credit
  @remaining_credit
end

#sent_to_contactObject

boolean to indicate if a credit note has been sent to a contact via the Xero app (currently read only)


82
83
84
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 82

def sent_to_contact
  @sent_to_contact
end

#statusObject

See Credit Note Status Codes


34
35
36
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 34

def status
  @status
end

#status_attribute_stringObject

A string to indicate if a invoice status


103
104
105
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 103

def status_attribute_string
  @status_attribute_string
end

#sub_totalObject

The subtotal of the credit note excluding taxes


49
50
51
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 49

def sub_total
  @sub_total
end

#totalObject

The total of the Credit Note(subtotal + total tax)


55
56
57
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 55

def total
  @total
end

#total_taxObject

The total tax on the credit note


52
53
54
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 52

def total_tax
  @total_tax
end

#typeObject

See Credit Note Types


20
21
22
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 20

def type
  @type
end

#updated_date_utcObject

UTC timestamp of last update to the credit note


64
65
66
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 64

def updated_date_utc
  @updated_date_utc
end

#validation_errorsObject

Displays array of validation error messages from the API


112
113
114
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 112

def validation_errors
  @validation_errors
end

#warningsObject

Displays array of warning messages from the API


115
116
117
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 115

def warnings
  @warnings
end

Class Method Details

.attribute_mapObject

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


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
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 140

def self.attribute_map
  {
    :'type' => :'Type',
    :'contact' => :'Contact',
    :'date' => :'Date',
    :'due_date' => :'DueDate',
    :'status' => :'Status',
    :'line_amount_types' => :'LineAmountTypes',
    :'line_items' => :'LineItems',
    :'sub_total' => :'SubTotal',
    :'total_tax' => :'TotalTax',
    :'total' => :'Total',
    :'cis_deduction' => :'CISDeduction',
    :'cis_rate' => :'CISRate',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'currency_code' => :'CurrencyCode',
    :'fully_paid_on_date' => :'FullyPaidOnDate',
    :'credit_note_id' => :'CreditNoteID',
    :'credit_note_number' => :'CreditNoteNumber',
    :'reference' => :'Reference',
    :'sent_to_contact' => :'SentToContact',
    :'currency_rate' => :'CurrencyRate',
    :'remaining_credit' => :'RemainingCredit',
    :'allocations' => :'Allocations',
    :'applied_amount' => :'AppliedAmount',
    :'payments' => :'Payments',
    :'branding_theme_id' => :'BrandingThemeID',
    :'status_attribute_string' => :'StatusAttributeString',
    :'has_attachments' => :'HasAttachments',
    :'has_errors' => :'HasErrors',
    :'validation_errors' => :'ValidationErrors',
    :'warnings' => :'Warnings'
  }
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


450
451
452
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 450

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_typesObject

Attribute type mapping.


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
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 176

def self.openapi_types
  {
    :'type' => :'String',
    :'contact' => :'Contact',
    :'date' => :'Date',
    :'due_date' => :'Date',
    :'status' => :'String',
    :'line_amount_types' => :'LineAmountTypes',
    :'line_items' => :'Array<LineItem>',
    :'sub_total' => :'BigDecimal',
    :'total_tax' => :'BigDecimal',
    :'total' => :'BigDecimal',
    :'cis_deduction' => :'BigDecimal',
    :'cis_rate' => :'BigDecimal',
    :'updated_date_utc' => :'DateTime',
    :'currency_code' => :'CurrencyCode',
    :'fully_paid_on_date' => :'Date',
    :'credit_note_id' => :'String',
    :'credit_note_number' => :'String',
    :'reference' => :'String',
    :'sent_to_contact' => :'Boolean',
    :'currency_rate' => :'BigDecimal',
    :'remaining_credit' => :'BigDecimal',
    :'allocations' => :'Array<Allocation>',
    :'applied_amount' => :'BigDecimal',
    :'payments' => :'Array<Payment>',
    :'branding_theme_id' => :'String',
    :'status_attribute_string' => :'String',
    :'has_attachments' => :'Boolean',
    :'has_errors' => :'Boolean',
    :'validation_errors' => :'Array<ValidationError>',
    :'warnings' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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
430
431
432
433
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 400

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      contact == o.contact &&
      date == o.date &&
      due_date == o.due_date &&
      status == o.status &&
      line_amount_types == o.line_amount_types &&
      line_items == o.line_items &&
      sub_total == o.sub_total &&
      total_tax == o.total_tax &&
      total == o.total &&
      cis_deduction == o.cis_deduction &&
      cis_rate == o.cis_rate &&
      updated_date_utc == o.updated_date_utc &&
      currency_code == o.currency_code &&
      fully_paid_on_date == o.fully_paid_on_date &&
      credit_note_id == o.credit_note_id &&
      credit_note_number == o.credit_note_number &&
      reference == o.reference &&
      sent_to_contact == o.sent_to_contact &&
      currency_rate == o.currency_rate &&
      remaining_credit == o.remaining_credit &&
      allocations == o.allocations &&
      applied_amount == o.applied_amount &&
      payments == o.payments &&
      branding_theme_id == o.branding_theme_id &&
      status_attribute_string == o.status_attribute_string &&
      has_attachments == o.has_attachments &&
      has_errors == o.has_errors &&
      validation_errors == o.validation_errors &&
      warnings == o.warnings
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


478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 478

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Accounting.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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


551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 551

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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


457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 457

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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

437
438
439
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 437

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


443
444
445
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 443

def hash
  [type, contact, date, due_date, status, line_amount_types, line_items, sub_total, total_tax, total, cis_deduction, cis_rate, updated_date_utc, currency_code, fully_paid_on_date, credit_note_id, credit_note_number, reference, sent_to_contact, currency_rate, remaining_credit, allocations, applied_amount, payments, branding_theme_id, status_attribute_string, has_attachments, has_errors, validation_errors, warnings].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


363
364
365
366
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 363

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


567
568
569
570
571
572
573
574
575
576
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 567

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case


543
544
545
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 543

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


525
526
527
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 525

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


531
532
533
534
535
536
537
538
539
540
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 531

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


519
520
521
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 519

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


370
371
372
373
374
375
376
# File 'lib/xero-ruby/models/accounting/credit_note.rb', line 370

def valid?
  type_validator = EnumAttributeValidator.new('String', ["ACCPAYCREDIT", "ACCRECCREDIT"])
  return false unless type_validator.valid?(@type)
  status_validator = EnumAttributeValidator.new('String', ["DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED"])
  return false unless status_validator.valid?(@status)
  true
end