Class: XeroRuby::Accounting::ExpenseClaim

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExpenseClaim

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
176
177
178
179
180
181
182
183
184
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 120

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_due ⇒ Object

The amount due to be paid for an expense claim



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

def amount_due
  @amount_due
end

#amount_paid ⇒ Object

The amount still to pay for an expense claim



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

def amount_paid
  @amount_paid
end

#expense_claim_id ⇒ Object

Xero generated unique identifier for an expense claim



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

def expense_claim_id
  @expense_claim_id
end

#payment_due_date ⇒ Object

The date when the expense claim is due to be paid YYYY-MM-DD



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

def payment_due_date
  @payment_due_date
end

#payments ⇒ Object

See Payments



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

def payments
  @payments
end

#receipt_id ⇒ Object

The Xero identifier for the Receipt e.g. e59a2c7f-1306-4078-a0f3-73537afcbba9



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

def receipt_id
  @receipt_id
end

#receipts ⇒ Object

Returns the value of attribute receipts.



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

def receipts
  @receipts
end

#reporting_date ⇒ Object

The date the expense claim will be reported in Xero YYYY-MM-DD



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

def reporting_date
  @reporting_date
end

#status ⇒ Object

Current status of an expense claim – see status types



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

def status
  @status
end

#total ⇒ Object

The total of an expense claim being paid



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

def total
  @total
end

#updated_date_utc ⇒ Object

Last modified date UTC format



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

def updated_date_utc
  @updated_date_utc
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 83

def self.attribute_map
  {
    :'expense_claim_id' => :'ExpenseClaimID',
    :'status' => :'Status',
    :'payments' => :'Payments',
    :'user' => :'User',
    :'receipts' => :'Receipts',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'total' => :'Total',
    :'amount_due' => :'AmountDue',
    :'amount_paid' => :'AmountPaid',
    :'payment_due_date' => :'PaymentDueDate',
    :'reporting_date' => :'ReportingDate',
    :'receipt_id' => :'ReceiptID'
  }
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



245
246
247
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 245

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 101

def self.openapi_types
  {
    :'expense_claim_id' => :'String',
    :'status' => :'String',
    :'payments' => :'Array<Payment>',
    :'user' => :'User',
    :'receipts' => :'Array<Receipt>',
    :'updated_date_utc' => :'DateTime',
    :'total' => :'BigDecimal',
    :'amount_due' => :'BigDecimal',
    :'amount_paid' => :'BigDecimal',
    :'payment_due_date' => :'Date',
    :'reporting_date' => :'Date',
    :'receipt_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expense_claim_id == o.expense_claim_id &&
      status == o.status &&
      payments == o.payments &&
      user == o.user &&
      receipts == o.receipts &&
      updated_date_utc == o.updated_date_utc &&
      total == o.total &&
      amount_due == o.amount_due &&
      amount_paid == o.amount_paid &&
      payment_due_date == o.payment_due_date &&
      reporting_date == o.reporting_date &&
      receipt_id == o.receipt_id
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



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

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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 346

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 252

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


232
233
234
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 232

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



238
239
240
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 238

def hash
  [expense_claim_id, status, payments, user, receipts, updated_date_utc, total, amount_due, amount_paid, payment_due_date, reporting_date, receipt_id].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



188
189
190
191
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 188

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 362

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
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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_attributes ⇒ Object

Returns the object in the form of hash with snake_case



338
339
340
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 338

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



320
321
322
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 320

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



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 326

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



314
315
316
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 314

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



195
196
197
198
199
 
# File 'lib/xero-ruby/models/accounting/expense_claim.rb', line 195

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