Class: XeroRuby::Accounting::LineItem

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LineItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_code ⇒ Object

See Accounts



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

def 
  @account_code
end

#account_id ⇒ Object

The associated account ID related to this line item



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

def 
  @account_id
end

#description ⇒ Object

Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a <Description> element that contains at least 1 character



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

def description
  @description
end

#discount_amount ⇒ Object

Discount amount being applied to a line item. Only supported on ACCREC invoices and quotes. ACCPAY invoices and credit notes in Xero do not support discounts.



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

def discount_amount
  @discount_amount
end

#discount_rate ⇒ Object

Percentage discount being applied to a line item (only supported on ACCREC invoices – ACC PAY invoices and credit notes in Xero do not support discounts



56
57
58
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 56

def discount_rate
  @discount_rate
end

#item ⇒ Object

Returns the value of attribute item.



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

def item
  @item
end

#item_code ⇒ Object

See Items



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

def item_code
  @item_code
end

#line_amount ⇒ Object

If you wish to omit either the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if either a DiscountRate or DiscountAmount has been used i.e. LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100) or LineAmount = (Quantity * UnitAmount) - DiscountAmount



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

def line_amount
  @line_amount
end

#line_item_id ⇒ Object

LineItem unique ID



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

def line_item_id
  @line_item_id
end

#quantity ⇒ Object

LineItem Quantity



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

def quantity
  @quantity
end

#repeating_invoice_id ⇒ Object

The Xero identifier for a Repeating Invoice



62
63
64
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 62

def repeating_invoice_id
  @repeating_invoice_id
end

#sales_tax_code_id ⇒ Object

The ID of the sales tax code



73
74
75
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 73

def sales_tax_code_id
  @sales_tax_code_id
end

#tax_amount ⇒ Object

The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct.



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

def tax_amount
  @tax_amount
end

#tax_breakdown ⇒ Object

An array of tax components defined for this line item



76
77
78
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 76

def tax_breakdown
  @tax_breakdown
end

#tax_type ⇒ Object

The tax type from TaxRates



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

def tax_type
  @tax_type
end

#taxability ⇒ Object

The type of taxability



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

def taxability
  @taxability
end

#tracking ⇒ Object

Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.



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

def tracking
  @tracking
end

#unit_amount ⇒ Object

LineItem Unit Amount



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

def unit_amount
  @unit_amount
end

Class Method Details

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 101

def self.attribute_map
  {
    :'line_item_id' => :'LineItemID',
    :'description' => :'Description',
    :'quantity' => :'Quantity',
    :'unit_amount' => :'UnitAmount',
    :'item_code' => :'ItemCode',
    :'account_code' => :'AccountCode',
    :'account_id' => :'AccountID',
    :'tax_type' => :'TaxType',
    :'tax_amount' => :'TaxAmount',
    :'item' => :'Item',
    :'line_amount' => :'LineAmount',
    :'tracking' => :'Tracking',
    :'discount_rate' => :'DiscountRate',
    :'discount_amount' => :'DiscountAmount',
    :'repeating_invoice_id' => :'RepeatingInvoiceID',
    :'taxability' => :'Taxability',
    :'sales_tax_code_id' => :'SalesTaxCodeId',
    :'tax_breakdown' => :'TaxBreakdown'
  }
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



305
306
307
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 305

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

.openapi_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 125

def self.openapi_types
  {
    :'line_item_id' => :'String',
    :'description' => :'String',
    :'quantity' => :'BigDecimal',
    :'unit_amount' => :'BigDecimal',
    :'item_code' => :'String',
    :'account_code' => :'String',
    :'account_id' => :'String',
    :'tax_type' => :'String',
    :'tax_amount' => :'BigDecimal',
    :'item' => :'LineItemItem',
    :'line_amount' => :'BigDecimal',
    :'tracking' => :'Array<LineItemTracking>',
    :'discount_rate' => :'BigDecimal',
    :'discount_amount' => :'BigDecimal',
    :'repeating_invoice_id' => :'String',
    :'taxability' => :'String',
    :'sales_tax_code_id' => :'Float',
    :'tax_breakdown' => :'Array<TaxBreakdownComponent>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/line_item.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      line_item_id == o.line_item_id &&
      description == o.description &&
      quantity == o.quantity &&
      unit_amount == o.unit_amount &&
      item_code == o.item_code &&
       == o. &&
       == o. &&
      tax_type == o.tax_type &&
      tax_amount == o.tax_amount &&
      item == o.item &&
      line_amount == o.line_amount &&
      tracking == o.tracking &&
      discount_rate == o.discount_rate &&
      discount_amount == o.discount_amount &&
      repeating_invoice_id == o.repeating_invoice_id &&
      taxability == o.taxability &&
      sales_tax_code_id == o.sales_tax_code_id &&
      tax_breakdown == o.tax_breakdown
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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 333

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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 406

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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 312

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [line_item_id, description, quantity, unit_amount, item_code, , , tax_type, tax_amount, item, line_amount, tracking, discount_rate, discount_amount, repeating_invoice_id, taxability, sales_tax_code_id, tax_breakdown].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



242
243
244
245
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 242

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 422

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



398
399
400
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 398

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



380
381
382
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 380

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



386
387
388
389
390
391
392
393
394
395
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 386

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



374
375
376
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 374

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



249
250
251
252
253
 
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 249

def valid?
  taxability_validator = EnumAttributeValidator.new('String', ["TAXABLE", "NON_TAXABLE", "EXEMPT", "PART_TAXABLE", "NOT_APPLICABLE"])
  return false unless taxability_validator.valid?(@taxability)
  true
end