class XeroGateway::LineItem
Constants
- TAX_TYPE
Attributes
account_code[RW]
All accessible fields
description[RW]
All accessible fields
discount_rate[RW]
All accessible fields
errors[R]
Any errors that occurred when the valid?
method called.
item_code[RW]
All accessible fields
line_item_id[RW]
All accessible fields
quantity[RW]
All accessible fields
tax_amount[RW]
All accessible fields
tax_type[RW]
All accessible fields
tracking[RW]
All accessible fields
unit_amount[RW]
All accessible fields
Public Class Methods
from_xml(line_item_element)
click to toggle source
# File lib/xero_gateway/line_item.rb, line 99 def self.from_xml(line_item_element) line_item = LineItem.new line_item_element.children.each do |element| case(element.name) when "LineItemID" then line_item.line_item_id = element.text when "Description" then line_item.description = element.text when "Quantity" then line_item.quantity = BigDecimal(element.text) when "UnitAmount" then line_item.unit_amount = BigDecimal(element.text) when "ItemCode" then line_item.item_code = element.text when "TaxType" then line_item.tax_type = element.text when "TaxAmount" then line_item.tax_amount = BigDecimal(element.text) when "LineAmount" then line_item.line_amount = BigDecimal(element.text) when "DiscountRate" then line_item.discount_rate = BigDecimal(element.text) when "AccountCode" then line_item.account_code = element.text when "Tracking" then element.children.each do | tracking_element | line_item.tracking << TrackingCategory.from_xml(tracking_element) end end end line_item end
new(params = {})
click to toggle source
# File lib/xero_gateway/line_item.rb, line 15 def initialize(params = {}) @errors ||= [] @tracking ||= [] @quantity = 1 @unit_amount = BigDecimal('0') params.each do |k,v| self.send("#{k}=", v) end end
Public Instance Methods
==(other)
click to toggle source
# File lib/xero_gateway/line_item.rb, line 122 def ==(other) [:description, :quantity, :unit_amount, :tax_type, :tax_amount, :line_amount, :discount_rate, :account_code, :item_code].each do |field| return false if send(field) != other.send(field) end return true end
has_tracking?()
click to toggle source
# File lib/xero_gateway/line_item.rb, line 50 def has_tracking? return false if tracking.nil? if tracking.is_a?(Array) return tracking.any? else return tracking.is_a?(TrackingCategory) end end
line_amount()
click to toggle source
Calculate the line_amount
as quantity * unit_amount
as this value must be correct for the API call to succeed.
# File lib/xero_gateway/line_item.rb, line 69 def line_amount total = quantity * unit_amount total = total * (1 - (discount_rate / BigDecimal(100))) if discount_rate total end
line_amount=(value)
click to toggle source
Deprecated (but API for setter remains).
As line_amount
must equal quantity * unit_amount
for the API call to pass, this is now automatically calculated in the line_amount
method.
# File lib/xero_gateway/line_item.rb, line 64 def line_amount=(value) end
to_xml(b = Builder::XmlMarkup.new)
click to toggle source
# File lib/xero_gateway/line_item.rb, line 75 def to_xml(b = Builder::XmlMarkup.new) b.LineItem { b.Description description b.Quantity quantity if quantity b.UnitAmount LineItem.format_money(unit_amount) b.ItemCode item_code if item_code b.TaxType tax_type if tax_type b.TaxAmount tax_amount if tax_amount b.LineAmount line_amount if line_amount b.DiscountRate discount_rate if discount_rate b.AccountCode account_code if account_code if has_tracking? b.Tracking { # Due to strange retardness in the Xero API, the XML structure for a tracking category within # an invoice is different to a standalone tracking category. # This means rather than going category.to_xml we need to call the special category.to_xml_for_invoice_messages (tracking.is_a?(TrackingCategory) ? [tracking] : tracking).each do |category| category.to_xml_for_invoice_messages(b) end } end } end
valid?()
click to toggle source
Validate the LineItem
record according to what will be valid by the gateway.
Usage:
line_item.valid? # Returns true/false Additionally sets line_item.errors array to an array of field/error.
# File lib/xero_gateway/line_item.rb, line 32 def valid? @errors = [] if !line_item_id.nil? && line_item_id !~ GUID_REGEX @errors << ['line_item_id', 'must be blank or a valid Xero GUID'] end unless description @errors << ['description', "can't be blank"] end if tax_type && !TAX_TYPE[tax_type] @errors << ['tax_type', "must be one of #{TAX_TYPE.keys.join('/')}"] end @errors.size == 0 end