Class: MergeAccountingClient::PaymentLineItem

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/models/payment_line_item.rb

Overview

# The PaymentLineItem Object ### Description The ‘PaymentLineItem` object is an applied-to-line on a `Payment` that can either be a `Invoice`, `CreditNote`, or `JournalEntry`. ### Usage Example `Payment` will have a field called `applied-to-lines` which will be an array of `PaymentLineItemInternalMappingSerializer` objects that can either be a `Invoice`, `CreditNote`, or `JournalEntry`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentLineItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 85

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

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

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

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

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

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

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

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

Instance Attribute Details

#applied_amount ⇒ Object

The amount being applied to the transaction.



20
21
22
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 20

def applied_amount
  @applied_amount
end

#applied_date ⇒ Object

The date the payment portion is applied.



23
24
25
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 23

def applied_date
  @applied_date
end

#created_at ⇒ Object

Returns the value of attribute created_at.



36
37
38
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 36

def created_at
  @created_at
end

#id ⇒ Object

Returns the value of attribute id.



34
35
36
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 34

def id
  @id
end

#modified_at ⇒ Object

This is the datetime that this object was last updated by Merge



39
40
41
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 39

def modified_at
  @modified_at
end

#related_object_id ⇒ Object

The Merge ID of the transaction the payment portion is being applied to.



29
30
31
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 29

def related_object_id
  @related_object_id
end

#related_object_type ⇒ Object

The type of transaction the payment portion is being applied to. Possible values include: INVOICE, JOURNAL_ENTRY, or CREDIT_NOTE.



32
33
34
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 32

def related_object_type
  @related_object_type
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



26
27
28
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 26

def remote_id
  @remote_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 42

def self.attribute_map
  {
    :'applied_amount' => :'applied_amount',
    :'applied_date' => :'applied_date',
    :'remote_id' => :'remote_id',
    :'related_object_id' => :'related_object_id',
    :'related_object_type' => :'related_object_type',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'modified_at' => :'modified_at'
  }
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
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 191

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
79
80
81
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 75

def self.openapi_nullable
  Set.new([
    :'applied_amount',
    :'applied_date',
    :'remote_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 61

def self.openapi_types
  {
    :'applied_amount' => :'String',
    :'applied_date' => :'Time',
    :'remote_id' => :'String',
    :'related_object_id' => :'String',
    :'related_object_type' => :'String',
    :'id' => :'String',
    :'created_at' => :'Time',
    :'modified_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      applied_amount == o.applied_amount &&
      applied_date == o.applied_date &&
      remote_id == o.remote_id &&
      related_object_id == o.related_object_id &&
      related_object_type == o.related_object_type &&
      id == o.id &&
      created_at == o.created_at &&
      modified_at == o.modified_at
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



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
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 221

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  when :Integer
    value.to_i
  when :Float
    value.to_f
  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
    # models (e.g. Pet) or oneOf
    klass = MergeAccountingClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 292

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 198

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


178
179
180
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



184
185
186
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 184

def hash
  [applied_amount, applied_date, remote_id, related_object_id, related_object_type, id, created_at, modified_at].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



133
134
135
136
137
138
139
140
141
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 133

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  if !@applied_amount.nil? && @applied_amount.to_s !~ pattern
    invalid_properties.push("invalid value for \"applied_amount\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



268
269
270
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 268

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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 274

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



262
263
264
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 262

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



145
146
147
148
 
# File 'lib/merge_accounting_client/models/payment_line_item.rb', line 145

def valid?
  return false if !@applied_amount.nil? && @applied_amount.to_s !~ Regexp.new(/^-?\d{0,32}(?:\.\d{0,16})?$/)
  true
end