Class: XeroRuby::Accounting::Journal

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

ACCREC =
"ACCREC".freeze
ACCPAY =
"ACCPAY".freeze
ACCRECCREDIT =
"ACCRECCREDIT".freeze
ACCPAYCREDIT =
"ACCPAYCREDIT".freeze
ACCRECPAYMENT =
"ACCRECPAYMENT".freeze
ACCPAYPAYMENT =
"ACCPAYPAYMENT".freeze
ARCREDITPAYMENT =
"ARCREDITPAYMENT".freeze
APCREDITPAYMENT =
"APCREDITPAYMENT".freeze
CASHREC =
"CASHREC".freeze
CASHPAID =
"CASHPAID".freeze
TRANSFER =
"TRANSFER".freeze
ARPREPAYMENT =
"ARPREPAYMENT".freeze
APPREPAYMENT =
"APPREPAYMENT".freeze
AROVERPAYMENT =
"AROVERPAYMENT".freeze
APOVERPAYMENT =
"APOVERPAYMENT".freeze
EXPCLAIM =
"EXPCLAIM".freeze
EXPPAYMENT =
"EXPPAYMENT".freeze
MANJOURNAL =
"MANJOURNAL".freeze
PAYSLIP =
"PAYSLIP".freeze
WAGEPAYABLE =
"WAGEPAYABLE".freeze
INTEGRATEDPAYROLLPE =
"INTEGRATEDPAYROLLPE".freeze
INTEGRATEDPAYROLLPT =
"INTEGRATEDPAYROLLPT".freeze
EXTERNALSPENDMONEY =
"EXTERNALSPENDMONEY".freeze
INTEGRATEDPAYROLLPTPAYMENT =
"INTEGRATEDPAYROLLPTPAYMENT".freeze
INTEGRATEDPAYROLLCN =
"INTEGRATEDPAYROLLCN".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Journal

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_date_utcObject

Created date UTC format


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

def created_date_utc
  @created_date_utc
end

#journal_dateObject

Date the journal was posted


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

def journal_date
  @journal_date
end

#journal_idObject

Xero identifier


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

def journal_id
  @journal_id
end

#journal_linesObject

See JournalLines


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

def journal_lines
  @journal_lines
end

#journal_numberObject

Xero generated journal number


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

def journal_number
  @journal_number
end

#referenceObject

reference field for additional indetifying information


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

def reference
  @reference
end

#source_idObject

The identifier for the source transaction (e.g. InvoiceID)


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

def source_id
  @source_id
end

#source_typeObject

The journal source type. The type of transaction that created the journal


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

def source_type
  @source_type
end

Class Method Details

.attribute_mapObject

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


91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/xero-ruby/models/accounting/journal.rb', line 91

def self.attribute_map
  {
    :'journal_id' => :'JournalID',
    :'journal_date' => :'JournalDate',
    :'journal_number' => :'JournalNumber',
    :'created_date_utc' => :'CreatedDateUTC',
    :'reference' => :'Reference',
    :'source_id' => :'SourceID',
    :'source_type' => :'SourceType',
    :'journal_lines' => :'JournalLines'
  }
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


223
224
225
# File 'lib/xero-ruby/models/accounting/journal.rb', line 223

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

.openapi_typesObject

Attribute type mapping.


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

def self.openapi_types
  {
    :'journal_id' => :'String',
    :'journal_date' => :'Date',
    :'journal_number' => :'Integer',
    :'created_date_utc' => :'DateTime',
    :'reference' => :'String',
    :'source_id' => :'String',
    :'source_type' => :'String',
    :'journal_lines' => :'Array<JournalLine>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/xero-ruby/models/accounting/journal.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      journal_id == o.journal_id &&
      journal_date == o.journal_date &&
      journal_number == o.journal_number &&
      created_date_utc == o.created_date_utc &&
      reference == o.reference &&
      source_id == o.source_id &&
      source_type == o.source_type &&
      journal_lines == o.journal_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


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
286
287
288
# File 'lib/xero-ruby/models/accounting/journal.rb', line 251

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


324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/xero-ruby/models/accounting/journal.rb', line 324

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


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'lib/xero-ruby/models/accounting/journal.rb', line 230

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

210
211
212
# File 'lib/xero-ruby/models/accounting/journal.rb', line 210

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


216
217
218
# File 'lib/xero-ruby/models/accounting/journal.rb', line 216

def hash
  [journal_id, journal_date, journal_number, created_date_utc, reference, source_id, source_type, journal_lines].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


170
171
172
173
# File 'lib/xero-ruby/models/accounting/journal.rb', line 170

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


340
341
342
343
344
345
346
347
348
349
# File 'lib/xero-ruby/models/accounting/journal.rb', line 340

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


316
317
318
# File 'lib/xero-ruby/models/accounting/journal.rb', line 316

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


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

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


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

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


292
293
294
# File 'lib/xero-ruby/models/accounting/journal.rb', line 292

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


177
178
179
180
181
# File 'lib/xero-ruby/models/accounting/journal.rb', line 177

def valid?
  source_type_validator = EnumAttributeValidator.new('String', ["ACCREC", "ACCPAY", "ACCRECCREDIT", "ACCPAYCREDIT", "ACCRECPAYMENT", "ACCPAYPAYMENT", "ARCREDITPAYMENT", "APCREDITPAYMENT", "CASHREC", "CASHPAID", "TRANSFER", "ARPREPAYMENT", "APPREPAYMENT", "AROVERPAYMENT", "APOVERPAYMENT", "EXPCLAIM", "EXPPAYMENT", "MANJOURNAL", "PAYSLIP", "WAGEPAYABLE", "INTEGRATEDPAYROLLPE", "INTEGRATEDPAYROLLPT", "EXTERNALSPENDMONEY", "INTEGRATEDPAYROLLPTPAYMENT", "INTEGRATEDPAYROLLCN"])
  return false unless source_type_validator.valid?(@source_type)
  true
end