Class: XeroRuby::Accounting::Account

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

ACTIVE = 
"ACTIVE".freeze
ARCHIVED = 
"ARCHIVED".freeze
DELETED = 
"DELETED".freeze
BANK = 
"BANK".freeze
CREDITCARD = 
"CREDITCARD".freeze
PAYPAL = 
"PAYPAL".freeze
NONE = 
"NONE".freeze
EMPTY = 
"".freeze
ASSET = 
"ASSET".freeze
EQUITY = 
"EQUITY".freeze
EXPENSE = 
"EXPENSE".freeze
LIABILITY = 
"LIABILITY".freeze
REVENUE = 
"REVENUE".freeze
DEBTORS = 
"DEBTORS".freeze
CREDITORS = 
"CREDITORS".freeze
BANKCURRENCYGAIN = 
"BANKCURRENCYGAIN".freeze
GST = 
"GST".freeze
GSTONIMPORTS = 
"GSTONIMPORTS".freeze
HISTORICAL = 
"HISTORICAL".freeze
REALISEDCURRENCYGAIN = 
"REALISEDCURRENCYGAIN".freeze
RETAINEDEARNINGS = 
"RETAINEDEARNINGS".freeze
ROUNDING = 
"ROUNDING".freeze
TRACKINGTRANSFERS = 
"TRACKINGTRANSFERS".freeze
UNPAIDEXPCLM = 
"UNPAIDEXPCLM".freeze
UNREALISEDCURRENCYGAIN = 
"UNREALISEDCURRENCYGAIN".freeze
WAGEPAYABLES = 
"WAGEPAYABLES".freeze
CISASSETS = 
"CISASSETS".freeze
CISASSET = 
"CISASSET".freeze
CISLABOUR = 
"CISLABOUR".freeze
CISLABOUREXPENSE = 
"CISLABOUREXPENSE".freeze
CISLABOURINCOME = 
"CISLABOURINCOME".freeze
CISLIABILITY = 
"CISLIABILITY".freeze
CISMATERIALS = 
"CISMATERIALS".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Account

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
283
284
285
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 189

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_class ⇒ Object

See Account Class Types



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

def _class
  @_class
end

#account_id ⇒ Object

The Xero identifier for an account – specified as a string following the endpoint name e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9



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

def 
  @account_id
end

#add_to_watchlist ⇒ Object

Boolean – describes whether the account is shown in the watchlist widget on the dashboard



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

def add_to_watchlist
  @add_to_watchlist
end

#bank_account_number ⇒ Object

For bank accounts only (Account Type BANK)



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

def 
  @bank_account_number
end

#bank_account_type ⇒ Object

For bank accounts only. See Bank Account types



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

def 
  @bank_account_type
end

#code ⇒ Object

Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)



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

def code
  @code
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#description ⇒ Object

Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)



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

def description
  @description
end

#enable_payments_to_account ⇒ Object

Boolean – describes whether account can have payments applied to it



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

def 
  @enable_payments_to_account
end

#has_attachments ⇒ Object

boolean to indicate if an account has an attachment (read only)



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

def has_attachments
  @has_attachments
end

#name ⇒ Object

Name of account (max length = 150)



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

def name
  @name
end

#reporting_code ⇒ Object

Shown if set



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

def reporting_code
  @reporting_code
end

#reporting_code_name ⇒ Object

Shown if set



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

def reporting_code_name
  @reporting_code_name
end

#show_in_expense_claims ⇒ Object

Boolean – describes whether account code is available for use with expense claims



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

def show_in_expense_claims
  @show_in_expense_claims
end

#status ⇒ Object

Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes



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

def status
  @status
end

#system_account ⇒ Object

If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.



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

def 
  @system_account
end

#tax_type ⇒ Object

The tax type from TaxRates



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

def tax_type
  @tax_type
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#updated_date_utc ⇒ Object

Last modified date UTC format



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

def updated_date_utc
  @updated_date_utc
end

#validation_errors ⇒ Object

Displays array of validation error messages from the API



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

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_map ⇒ Object

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 136

def self.attribute_map
  {
    :'code' => :'Code',
    :'name' => :'Name',
    :'account_id' => :'AccountID',
    :'type' => :'Type',
    :'bank_account_number' => :'BankAccountNumber',
    :'status' => :'Status',
    :'description' => :'Description',
    :'bank_account_type' => :'BankAccountType',
    :'currency_code' => :'CurrencyCode',
    :'tax_type' => :'TaxType',
    :'enable_payments_to_account' => :'EnablePaymentsToAccount',
    :'show_in_expense_claims' => :'ShowInExpenseClaims',
    :'_class' => :'Class',
    :'system_account' => :'SystemAccount',
    :'reporting_code' => :'ReportingCode',
    :'reporting_code_name' => :'ReportingCodeName',
    :'has_attachments' => :'HasAttachments',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'add_to_watchlist' => :'AddToWatchlist',
    :'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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 162

def self.openapi_types
  {
    :'code' => :'String',
    :'name' => :'String',
    :'account_id' => :'String',
    :'type' => :'AccountType',
    :'bank_account_number' => :'String',
    :'status' => :'String',
    :'description' => :'String',
    :'bank_account_type' => :'String',
    :'currency_code' => :'CurrencyCode',
    :'tax_type' => :'String',
    :'enable_payments_to_account' => :'Boolean',
    :'show_in_expense_claims' => :'Boolean',
    :'_class' => :'String',
    :'system_account' => :'String',
    :'reporting_code' => :'String',
    :'reporting_code_name' => :'String',
    :'has_attachments' => :'Boolean',
    :'updated_date_utc' => :'DateTime',
    :'add_to_watchlist' => :'Boolean',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 365

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      name == o.name &&
       == o. &&
      type == o.type &&
       == o. &&
      status == o.status &&
      description == o.description &&
       == o. &&
      currency_code == o.currency_code &&
      tax_type == o.tax_type &&
       == o. &&
      show_in_expense_claims == o.show_in_expense_claims &&
      _class == o._class &&
       == o. &&
      reporting_code == o.reporting_code &&
      reporting_code_name == o.reporting_code_name &&
      has_attachments == o.has_attachments &&
      updated_date_utc == o.updated_date_utc &&
      add_to_watchlist == o.add_to_watchlist &&
      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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 433

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



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 506

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



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

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


392
393
394
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 392

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



398
399
400
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 398

def hash
  [code, name, , type, , status, description, , currency_code, tax_type, , show_in_expense_claims, _class, , reporting_code, reporting_code_name, has_attachments, updated_date_utc, add_to_watchlist, validation_errors].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



289
290
291
292
293
294
295
296
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 289

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 150
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 150.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



520
521
522
523
524
525
526
527
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 520

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_attributes ⇒ Object

Returns the object in the form of hash with snake_case



498
499
500
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 498

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



480
481
482
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 480

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



486
487
488
489
490
491
492
493
494
495
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 486

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

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



300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/xero-ruby/models/accounting/account.rb', line 300

def valid?
  return false if !@name.nil? && @name.to_s.length > 150
  status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED", "DELETED"])
  return false unless status_validator.valid?(@status)
   = EnumAttributeValidator.new('String', ["BANK", "CREDITCARD", "PAYPAL", "NONE", ""])
  return false unless .valid?(@bank_account_type)
  _class_validator = EnumAttributeValidator.new('String', ["ASSET", "EQUITY", "EXPENSE", "LIABILITY", "REVENUE"])
  return false unless _class_validator.valid?(@_class)
   = EnumAttributeValidator.new('String', ["DEBTORS", "CREDITORS", "BANKCURRENCYGAIN", "GST", "GSTONIMPORTS", "HISTORICAL", "REALISEDCURRENCYGAIN", "RETAINEDEARNINGS", "ROUNDING", "TRACKINGTRANSFERS", "UNPAIDEXPCLM", "UNREALISEDCURRENCYGAIN", "WAGEPAYABLES", "CISASSETS", "CISASSET", "CISLABOUR", "CISLABOUREXPENSE", "CISLABOURINCOME", "CISLIABILITY", "CISMATERIALS", ""])
  return false unless .valid?(@system_account)
  true
end