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



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

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

Created date UTC format



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

def created_date_utc
  @created_date_utc
end

#journal_date ⇒ Object

Date the journal was posted



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

def journal_date
  @journal_date
end

#journal_id ⇒ Object

Xero identifier



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

def journal_id
  @journal_id
end

#journal_lines ⇒ Object

See JournalLines



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

def journal_lines
  @journal_lines
end

#journal_number ⇒ Object

Xero generated journal number



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

def journal_number
  @journal_number
end

#reference ⇒ Object

reference field for additional indetifying information



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

def reference
  @reference
end

#source_id ⇒ Object

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



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

def source_id
  @source_id
end

#source_type ⇒ Object

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



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

def source_type
  @source_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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



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

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



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

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/xero-ruby/models/accounting/journal.rb', line 319

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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [journal_id, journal_date, journal_number, created_date_utc, reference, source_id, source_type, journal_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



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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



334
335
336
337
 
# File 'lib/xero-ruby/models/accounting/journal.rb', line 334

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

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



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

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