class XeroRuby::Accounting::LineItem
Attributes
See Accounts
The associated account ID related to this line item
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
Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts.
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
See Items
If you wish to omit either of 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 a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100)
LineItem
unique ID
LineItem
Quantity
The Xero identifier for a Repeating Invoice
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.
The tax type from TaxRates
Optional Tracking Category – see Tracking. Any LineItem
can have a maximum of 2 <TrackingCategory> elements.
LineItem
Unit Amount
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/accounting/line_item.rb, line 62 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', :'line_amount' => :'LineAmount', :'tracking' => :'Tracking', :'discount_rate' => :'DiscountRate', :'discount_amount' => :'DiscountAmount', :'repeating_invoice_id' => :'RepeatingInvoiceID' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/accounting/line_item.rb, line 224 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/xero-ruby/models/accounting/line_item.rb, line 103 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.account_code = attributes[:'account_code'] end if attributes.key?(:'account_id') self.account_id = 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?(:'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 end
Attribute type mapping.
# File lib/xero-ruby/models/accounting/line_item.rb, line 82 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', :'line_amount' => :'BigDecimal', :'tracking' => :'Array<LineItemTracking>', :'discount_rate' => :'BigDecimal', :'discount_amount' => :'BigDecimal', :'repeating_invoice_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/line_item.rb, line 190 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 && account_code == o.account_code && account_id == o.account_id && tax_type == o.tax_type && tax_amount == o.tax_amount && 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 end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/xero-ruby/models/accounting/line_item.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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/xero-ruby/models/accounting/line_item.rb, line 325 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/accounting/line_item.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
@see the `==` method @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/line_item.rb, line 211 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/accounting/line_item.rb, line 217 def hash [line_item_id, description, quantity, unit_amount, item_code, account_code, account_id, tax_type, tax_amount, line_amount, tracking, discount_rate, discount_amount, repeating_invoice_id].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/xero-ruby/models/accounting/line_item.rb, line 177 def list_invalid_properties invalid_properties = Array.new invalid_properties end
# File lib/xero-ruby/models/accounting/line_item.rb, line 341 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
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/accounting/line_item.rb, line 317 def to_attributes to_hash(downcase: true) end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/xero-ruby/models/accounting/line_item.rb, line 305 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/accounting/line_item.rb, line 293 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/xero-ruby/models/accounting/line_item.rb, line 184 def valid? true end