Class: XeroRuby::Accounting::Receipt

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

DRAFT =
"DRAFT".freeze
SUBMITTED =
"SUBMITTED".freeze
AUTHORISED =
"AUTHORISED".freeze
DECLINED =
"DECLINED".freeze
VOIDED =
"VOIDED".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Receipt

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
242
243
244
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 150

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Receipt` 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::Receipt`. 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?(:'date')
    self.date = attributes[:'date']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  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

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

Instance Attribute Details

#attachmentsObject

Displays array of attachments from the API


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

def attachments
  @attachments
end

#contactObject

Returns the value of attribute contact


23
24
25
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 23

def contact
  @contact
end

#dateObject

Date of receipt – YYYY-MM-DD


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

def date
  @date
end

#has_attachmentsObject

boolean to indicate if a receipt has an attachment


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

def has_attachments
  @has_attachments
end

#line_amount_typesObject

Returns the value of attribute line_amount_types


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

def line_amount_types
  @line_amount_types
end

#line_itemsObject

Returns the value of attribute line_items


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

def line_items
  @line_items
end

#receipt_idObject

Xero generated unique identifier for receipt


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

def receipt_id
  @receipt_id
end

#receipt_numberObject

Xero generated sequence number for receipt in current claim for a given user


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

def receipt_number
  @receipt_number
end

#referenceObject

Additional reference number


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

def reference
  @reference
end

#statusObject

Current status of receipt – see status types


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

def status
  @status
end

#sub_totalObject

Total of receipt excluding taxes


38
39
40
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 38

def sub_total
  @sub_total
end

#totalObject

Total of receipt tax inclusive (i.e. SubTotal + TotalTax)


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

def total
  @total
end

#total_taxObject

Total tax on receipt


41
42
43
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 41

def total_tax
  @total_tax
end

#updated_date_utcObject

Last modified date UTC format


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

def updated_date_utc
  @updated_date_utc
end

#urlObject

URL link to a source document – shown as “Go to [appName]” in the Xero app


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

def url
  @url
end

#userObject

Returns the value of attribute user


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

def user
  @user
end

#validation_errorsObject

Displays array of validation error messages from the API


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

def validation_errors
  @validation_errors
end

#warningsObject

Displays array of warning messages from the API


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

def warnings
  @warnings
end

Class Method Details

.attribute_mapObject

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


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 101

def self.attribute_map
  {
    :'date' => :'Date',
    :'contact' => :'Contact',
    :'line_items' => :'LineItems',
    :'user' => :'User',
    :'reference' => :'Reference',
    :'line_amount_types' => :'LineAmountTypes',
    :'sub_total' => :'SubTotal',
    :'total_tax' => :'TotalTax',
    :'total' => :'Total',
    :'receipt_id' => :'ReceiptID',
    :'status' => :'Status',
    :'receipt_number' => :'ReceiptNumber',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'has_attachments' => :'HasAttachments',
    :'url' => :'Url',
    :'validation_errors' => :'ValidationErrors',
    :'warnings' => :'Warnings',
    :'attachments' => :'Attachments'
  }
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


311
312
313
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 311

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

.openapi_typesObject

Attribute type mapping.


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 125

def self.openapi_types
  {
    :'date' => :'Date',
    :'contact' => :'Contact',
    :'line_items' => :'Array<LineItem>',
    :'user' => :'User',
    :'reference' => :'String',
    :'line_amount_types' => :'LineAmountTypes',
    :'sub_total' => :'BigDecimal',
    :'total_tax' => :'BigDecimal',
    :'total' => :'BigDecimal',
    :'receipt_id' => :'String',
    :'status' => :'String',
    :'receipt_number' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'has_attachments' => :'Boolean',
    :'url' => :'String',
    :'validation_errors' => :'Array<ValidationError>',
    :'warnings' => :'Array<ValidationError>',
    :'attachments' => :'Array<Attachment>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 273

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      contact == o.contact &&
      line_items == o.line_items &&
      user == o.user &&
      reference == o.reference &&
      line_amount_types == o.line_amount_types &&
      sub_total == o.sub_total &&
      total_tax == o.total_tax &&
      total == o.total &&
      receipt_id == o.receipt_id &&
      status == o.status &&
      receipt_number == o.receipt_number &&
      updated_date_utc == o.updated_date_utc &&
      has_attachments == o.has_attachments &&
      url == o.url &&
      validation_errors == o.validation_errors &&
      warnings == o.warnings &&
      attachments == o.attachments
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


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
368
369
370
371
372
373
374
375
376
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 339

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


412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 412

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


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 318

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

298
299
300
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 298

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


304
305
306
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 304

def hash
  [date, contact, line_items, user, reference, line_amount_types, sub_total, total_tax, total, receipt_id, status, receipt_number, updated_date_utc, has_attachments, url, validation_errors, warnings, attachments].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


248
249
250
251
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 248

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


428
429
430
431
432
433
434
435
436
437
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 428

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


404
405
406
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 404

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


386
387
388
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 386

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


392
393
394
395
396
397
398
399
400
401
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 392

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


380
381
382
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 380

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


255
256
257
258
259
# File 'lib/xero-ruby/models/accounting/receipt.rb', line 255

def valid?
  status_validator = EnumAttributeValidator.new('String', ["DRAFT", "SUBMITTED", "AUTHORISED", "DECLINED", "VOIDED"])
  return false unless status_validator.valid?(@status)
  true
end