Class: XeroRuby::Finance::StatementResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StatementResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 83

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#end_balance ⇒ Object

Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0.



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

def end_balance
  @end_balance
end

#end_date ⇒ Object

End date of statement



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

def end_date
  @end_date
end

#import_source ⇒ Object

Identifies where the statement data in Xero was sourced, 1) direct bank feed, automatically loaded from the bank (eg STMTIMPORTSRC/CBAFEED); 2) indirect bank feed, automatically loaded from a 3rd party provider (eg STMTIMPORTSRC/YODLEE); 3) manually uploaded bank feed (eg STMTIMPORTSRC/CSV) or 4) manually entered statement data (STMTIMPORTSRC/MANUAL).



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

def import_source
  @import_source
end

#imported_date_time_utc ⇒ Object

Utc date time of when the statement was imported in Xero



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

def imported_date_time_utc
  @imported_date_time_utc
end

#indicative_end_balance ⇒ Object

Closing statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn’t match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there’s an error in the bank statement lines in Xero. Ref: central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true



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

def indicative_end_balance
  @indicative_end_balance
end

#indicative_start_balance ⇒ Object

Opening statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn’t match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there’s an error in the bank statement lines in Xero. Ref: central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true



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

def indicative_start_balance
  @indicative_start_balance
end

#start_balance ⇒ Object

Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0.



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

def start_balance
  @start_balance
end

#start_date ⇒ Object

Start date of statement



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

def start_date
  @start_date
end

#statement_id ⇒ Object

Xero Identifier of statement



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

def statement_id
  @statement_id
end

#statement_lines ⇒ Object

List of statement lines



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

def statement_lines
  @statement_lines
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 50

def self.attribute_map
  {
    :'statement_id' => :'statementId',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'imported_date_time_utc' => :'importedDateTimeUtc',
    :'import_source' => :'importSource',
    :'start_balance' => :'startBalance',
    :'end_balance' => :'endBalance',
    :'indicative_start_balance' => :'indicativeStartBalance',
    :'indicative_end_balance' => :'indicativeEndBalance',
    :'statement_lines' => :'statementLines'
  }
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



184
185
186
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 184

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 66

def self.openapi_types
  {
    :'statement_id' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'imported_date_time_utc' => :'DateTime',
    :'import_source' => :'String',
    :'start_balance' => :'BigDecimal',
    :'end_balance' => :'BigDecimal',
    :'indicative_start_balance' => :'BigDecimal',
    :'indicative_end_balance' => :'BigDecimal',
    :'statement_lines' => :'Array<StatementLineResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      statement_id == o.statement_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      imported_date_time_utc == o.imported_date_time_utc &&
      import_source == o.import_source &&
      start_balance == o.start_balance &&
      end_balance == o.end_balance &&
      indicative_start_balance == o.indicative_start_balance &&
      indicative_end_balance == o.indicative_end_balance &&
      statement_lines == o.statement_lines
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



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
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 212

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::Finance.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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 285

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 191

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


171
172
173
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



177
178
179
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 177

def hash
  [statement_id, start_date, end_date, imported_date_time_utc, import_source, start_balance, end_balance, indicative_start_balance, indicative_end_balance, statement_lines].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



141
142
143
144
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 141

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



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

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



277
278
279
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 277

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



259
260
261
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 259

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



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 265

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



253
254
255
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 253

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



148
149
150
 
# File 'lib/xero-ruby/models/finance/statement_response.rb', line 148

def valid?
  true
end