Class: XeroRuby::Accounting::LinkedTransaction

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

APPROVED =
"APPROVED".freeze
DRAFT =
"DRAFT".freeze
ONDRAFT =
"ONDRAFT".freeze
BILLED =
"BILLED".freeze
VOIDED =
"VOIDED".freeze
BILLABLEEXPENSE =
"BILLABLEEXPENSE".freeze
ACCPAY =
"ACCPAY".freeze
SPEND =
"SPEND".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkedTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash


118
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
145
146
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
173
174
175
176
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#contact_idObject

Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED.


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

def contact_id
  @contact_id
end

#linked_transaction_idObject

The Xero identifier for an Linked Transaction e.g./LinkedTransactions/297c2dc5-cc47-4afd-8ec8-74990b8761e9


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

def linked_transaction_id
  @linked_transaction_id
end

#source_line_item_idObject

The line item identifier from the source transaction.


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

def source_line_item_id
  @source_line_item_id
end

#source_transaction_idObject

Filter by the SourceTransactionID. Get all the linked transactions created from a particular ACCPAY invoice


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

def source_transaction_id
  @source_transaction_id
end

#source_transaction_type_codeObject

The Type of the source tranasction. This will be ACCPAY if the linked transaction was created from an invoice and SPEND if it was created from a bank transaction.


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

def source_transaction_type_code
  @source_transaction_type_code
end

#statusObject

Filter by the combination of ContactID and Status. Get all the linked transactions that have been assigned to a particular customer and have a particular status e.g. GET /LinkedTransactions?ContactID=4bb34b03-3378-4bb2-a0ed-6345abf3224e&Status=APPROVED.


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

def status
  @status
end

#target_line_item_idObject

The line item identifier from the target transaction. It is possible to link multiple billable expenses to the same TargetLineItemID.


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

def target_line_item_id
  @target_line_item_id
end

#target_transaction_idObject

Filter by the TargetTransactionID. Get all the linked transactions allocated to a particular ACCREC invoice


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

def target_transaction_id
  @target_transaction_id
end

#typeObject

This will always be BILLABLEEXPENSE. More types may be added in future.


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

def type
  @type
end

#updated_date_utcObject

The last modified date in UTC format


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

def updated_date_utc
  @updated_date_utc
end

#validation_errorsObject

Displays array of validation error messages from the API


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

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_mapObject

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


83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 83

def self.attribute_map
  {
    :'source_transaction_id' => :'SourceTransactionID',
    :'source_line_item_id' => :'SourceLineItemID',
    :'contact_id' => :'ContactID',
    :'target_transaction_id' => :'TargetTransactionID',
    :'target_line_item_id' => :'TargetLineItemID',
    :'linked_transaction_id' => :'LinkedTransactionID',
    :'status' => :'Status',
    :'type' => :'Type',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'source_transaction_type_code' => :'SourceTransactionTypeCode',
    :'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


260
261
262
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 260

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

.openapi_typesObject

Attribute type mapping.


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 100

def self.openapi_types
  {
    :'source_transaction_id' => :'String',
    :'source_line_item_id' => :'String',
    :'contact_id' => :'String',
    :'target_transaction_id' => :'String',
    :'target_line_item_id' => :'String',
    :'linked_transaction_id' => :'String',
    :'status' => :'String',
    :'type' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'source_transaction_type_code' => :'String',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      source_transaction_id == o.source_transaction_id &&
      source_line_item_id == o.source_line_item_id &&
      contact_id == o.contact_id &&
      target_transaction_id == o.target_transaction_id &&
      target_line_item_id == o.target_line_item_id &&
      linked_transaction_id == o.linked_transaction_id &&
      status == o.status &&
      type == o.type &&
      updated_date_utc == o.updated_date_utc &&
      source_transaction_type_code == o.source_transaction_type_code &&
      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


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 288

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


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 361

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


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 267

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

247
248
249
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 247

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


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

def hash
  [source_transaction_id, source_line_item_id, contact_id, target_transaction_id, target_line_item_id, linked_transaction_id, status, type, updated_date_utc, source_transaction_type_code, 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


180
181
182
183
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 180

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


377
378
379
380
381
382
383
384
385
386
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 377

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


353
354
355
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 353

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


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

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


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

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


329
330
331
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 329

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


187
188
189
190
191
192
193
194
195
# File 'lib/xero-ruby/models/accounting/linked_transaction.rb', line 187

def valid?
  status_validator = EnumAttributeValidator.new('String', ["APPROVED", "DRAFT", "ONDRAFT", "BILLED", "VOIDED"])
  return false unless status_validator.valid?(@status)
  type_validator = EnumAttributeValidator.new('String', ["BILLABLEEXPENSE"])
  return false unless type_validator.valid?(@type)
  source_transaction_type_code_validator = EnumAttributeValidator.new('String', ["ACCPAY", "SPEND"])
  return false unless source_transaction_type_code_validator.valid?(@source_transaction_type_code)
  true
end