Class: XeroRuby::Accounting::BankTransaction

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

RECEIVE =
"RECEIVE".freeze
RECEIVE_OVERPAYMENT =
"RECEIVE-OVERPAYMENT".freeze
RECEIVE_PREPAYMENT =
"RECEIVE-PREPAYMENT".freeze
SPEND =
"SPEND".freeze
SPEND_OVERPAYMENT =
"SPEND-OVERPAYMENT".freeze
SPEND_PREPAYMENT =
"SPEND-PREPAYMENT".freeze
RECEIVE_TRANSFER =
"RECEIVE-TRANSFER".freeze
SPEND_TRANSFER =
"SPEND-TRANSFER".freeze
AUTHORISED =
"AUTHORISED".freeze
DELETED =
"DELETED".freeze
VOIDED =
"VOIDED".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BankTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_accountObject

Returns the value of attribute bank_account


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

def 
  @bank_account
end

#bank_transaction_idObject

Xero generated unique identifier for bank transaction


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

def bank_transaction_id
  @bank_transaction_id
end

#contactObject

Returns the value of attribute contact


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

def contact
  @contact
end

#currency_codeObject

Returns the value of attribute currency_code


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

def currency_code
  @currency_code
end

#currency_rateObject

Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments.


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

def currency_rate
  @currency_rate
end

#dateObject

Date of transaction – YYYY-MM-DD


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

def date
  @date
end

#has_attachmentsObject

Boolean to indicate if a bank transaction has an attachment


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

def has_attachments
  @has_attachments
end

#is_reconciledObject

Boolean to show if transaction is reconciled


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

def is_reconciled
  @is_reconciled
end

#line_amount_typesObject

Returns the value of attribute line_amount_types


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

def line_amount_types
  @line_amount_types
end

#line_itemsObject

See LineItems


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

def line_items
  @line_items
end

#overpayment_idObject

Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT


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

def overpayment_id
  @overpayment_id
end

#prepayment_idObject

Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT


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

def prepayment_id
  @prepayment_id
end

#referenceObject

Reference for the transaction. Only supported for SPEND and RECEIVE transactions.


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

def reference
  @reference
end

#statusObject

See Bank Transaction Status Codes


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

def status
  @status
end

#status_attribute_stringObject

A string to indicate if a invoice status


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

def status_attribute_string
  @status_attribute_string
end

#sub_totalObject

Total of bank transaction excluding taxes


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

def sub_total
  @sub_total
end

#totalObject

Total of bank transaction tax inclusive


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

def total
  @total
end

#total_taxObject

Total tax on bank transaction


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

def total_tax
  @total_tax
end

#typeObject

See Bank Transaction Types


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

def type
  @type
end

#updated_date_utcObject

Last modified date UTC format


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

def updated_date_utc
  @updated_date_utc
end

#urlObject

URL link to a source document – shown as “Go to App Name”


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

def url
  @url
end

#validation_errorsObject

Displays array of validation error messages from the API


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

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'type' => :'Type',
    :'contact' => :'Contact',
    :'line_items' => :'LineItems',
    :'bank_account' => :'BankAccount',
    :'is_reconciled' => :'IsReconciled',
    :'date' => :'Date',
    :'reference' => :'Reference',
    :'currency_code' => :'CurrencyCode',
    :'currency_rate' => :'CurrencyRate',
    :'url' => :'Url',
    :'status' => :'Status',
    :'line_amount_types' => :'LineAmountTypes',
    :'sub_total' => :'SubTotal',
    :'total_tax' => :'TotalTax',
    :'total' => :'Total',
    :'bank_transaction_id' => :'BankTransactionID',
    :'prepayment_id' => :'PrepaymentID',
    :'overpayment_id' => :'OverpaymentID',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'has_attachments' => :'HasAttachments',
    :'status_attribute_string' => :'StatusAttributeString',
    :'validation_errors' => :'ValidationErrors'
  }
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


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

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

.openapi_typesObject

Attribute type mapping.


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

def self.openapi_types
  {
    :'type' => :'String',
    :'contact' => :'Contact',
    :'line_items' => :'Array<LineItem>',
    :'bank_account' => :'Account',
    :'is_reconciled' => :'Boolean',
    :'date' => :'Date',
    :'reference' => :'String',
    :'currency_code' => :'CurrencyCode',
    :'currency_rate' => :'BigDecimal',
    :'url' => :'String',
    :'status' => :'String',
    :'line_amount_types' => :'LineAmountTypes',
    :'sub_total' => :'BigDecimal',
    :'total_tax' => :'BigDecimal',
    :'total' => :'BigDecimal',
    :'bank_transaction_id' => :'String',
    :'prepayment_id' => :'String',
    :'overpayment_id' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'has_attachments' => :'Boolean',
    :'status_attribute_string' => :'String',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      contact == o.contact &&
      line_items == o.line_items &&
       == o. &&
      is_reconciled == o.is_reconciled &&
      date == o.date &&
      reference == o.reference &&
      currency_code == o.currency_code &&
      currency_rate == o.currency_rate &&
      url == o.url &&
      status == o.status &&
      line_amount_types == o.line_amount_types &&
      sub_total == o.sub_total &&
      total_tax == o.total_tax &&
      total == o.total &&
      bank_transaction_id == o.bank_transaction_id &&
      prepayment_id == o.prepayment_id &&
      overpayment_id == o.overpayment_id &&
      updated_date_utc == o.updated_date_utc &&
      has_attachments == o.has_attachments &&
      status_attribute_string == o.status_attribute_string &&
      validation_errors == o.validation_errors
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


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
434
435
436
437
438
439
440
441
442
443
444
445
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 408

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) ⇒ 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


481
482
483
484
485
486
487
488
489
490
491
492
493
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 481

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

#attributesObject

Returns the object in the form of hash with snake_case


473
474
475
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 473

def attributes
  to_hash(downcase: true)
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


387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 387

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

367
368
369
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 367

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


373
374
375
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 373

def hash
  [type, contact, line_items, , is_reconciled, date, reference, currency_code, currency_rate, url, status, line_amount_types, sub_total, total_tax, total, bank_transaction_id, prepayment_id, overpayment_id, updated_date_utc, has_attachments, status_attribute_string, validation_errors].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 286

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


495
496
497
498
499
500
501
502
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 495

def parse_date(datestring)
  if datestring.include?('Date')
    seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
    Time.at(seconds_since_epoch).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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


455
456
457
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 455

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


461
462
463
464
465
466
467
468
469
470
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 461

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)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


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

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


305
306
307
308
309
310
311
312
313
314
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 305

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["RECEIVE", "RECEIVE-OVERPAYMENT", "RECEIVE-PREPAYMENT", "SPEND", "SPEND-OVERPAYMENT", "SPEND-PREPAYMENT", "RECEIVE-TRANSFER", "SPEND-TRANSFER"])
  return false unless type_validator.valid?(@type)
  return false if @line_items.nil?
  return false if @bank_account.nil?
  status_validator = EnumAttributeValidator.new('String', ["AUTHORISED", "DELETED", "VOIDED"])
  return false unless status_validator.valid?(@status)
  true
end