Class: XeroRuby::Accounting::LineItem
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::LineItem
- Defined in:
- lib/xero-ruby/models/accounting/line_item.rb
Instance Attribute Summary collapse
-
#account_code ⇒ Object
See Accounts.
-
#description ⇒ Object
Description needs to be at least 1 char long.
-
#discount_amount ⇒ Object
Discount amount being applied to a line item.
-
#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.
-
#item_code ⇒ Object
See Items.
-
#line_amount ⇒ Object
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.
-
#line_item_id ⇒ Object
LineItem unique ID.
-
#quantity ⇒ Object
LineItem Quantity.
-
#repeating_invoice_id ⇒ Object
The Xero identifier for a Repeating Invoice.
-
#tax_amount ⇒ Object
The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate.
-
#tax_type ⇒ Object
The tax type from TaxRates.
-
#tracking ⇒ Object
Optional Tracking Category – see Tracking.
-
#unit_amount ⇒ Object
LineItem Unit Amount.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ LineItem
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#parse_date(datestring) ⇒ Object
customized data_parser.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ LineItem
Initializes the object
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 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 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 97 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?(:'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 |
Instance Attribute Details
#account_code ⇒ Object
See Accounts
34 35 36 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 34 def account_code @account_code 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
22 23 24 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 22 def description @description end |
#discount_amount ⇒ Object
Discount amount being applied to a line item. Only supported on ACCREC invoices - ACCPAY invoices and credit notes in Xero do not support discounts.
52 53 54 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 52 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
49 50 51 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 49 def discount_rate @discount_rate end |
#item_code ⇒ Object
See Items
31 32 33 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 31 def item_code @item_code end |
#line_amount ⇒ Object
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)
43 44 45 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 43 def line_amount @line_amount end |
#line_item_id ⇒ Object
LineItem unique ID
19 20 21 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 19 def line_item_id @line_item_id end |
#quantity ⇒ Object
LineItem Quantity
25 26 27 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 25 def quantity @quantity end |
#repeating_invoice_id ⇒ Object
The Xero identifier for a Repeating Invoice
55 56 57 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 55 def repeating_invoice_id @repeating_invoice_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.
40 41 42 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 40 def tax_amount @tax_amount end |
#tax_type ⇒ Object
The tax type from TaxRates
37 38 39 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 37 def tax_type @tax_type end |
#tracking ⇒ Object
Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.
46 47 48 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 46 def tracking @tracking end |
#unit_amount ⇒ Object
LineItem Unit Amount
28 29 30 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 28 def unit_amount @unit_amount end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 58 def self.attribute_map { :'line_item_id' => :'LineItemID', :'description' => :'Description', :'quantity' => :'Quantity', :'unit_amount' => :'UnitAmount', :'item_code' => :'ItemCode', :'account_code' => :'AccountCode', :'tax_type' => :'TaxType', :'tax_amount' => :'TaxAmount', :'line_amount' => :'LineAmount', :'tracking' => :'Tracking', :'discount_rate' => :'DiscountRate', :'discount_amount' => :'DiscountAmount', :'repeating_invoice_id' => :'RepeatingInvoiceID' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
213 214 215 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 213 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 77 def self.openapi_types { :'line_item_id' => :'String', :'description' => :'String', :'quantity' => :'Float', :'unit_amount' => :'Float', :'item_code' => :'String', :'account_code' => :'String', :'tax_type' => :'String', :'tax_amount' => :'Float', :'line_amount' => :'Float', :'tracking' => :'Array<LineItemTracking>', :'discount_rate' => :'Float', :'discount_amount' => :'Float', :'repeating_invoice_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 180 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 && 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 |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 241 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 :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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 306 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
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 220 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
200 201 202 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 200 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
206 207 208 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 206 def hash [line_item_id, description, quantity, unit_amount, item_code, account_code, tax_type, tax_amount, line_amount, tracking, discount_rate, discount_amount, repeating_invoice_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
167 168 169 170 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 167 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
321 322 323 324 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 321 def parse_date(datestring) seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0 return Time.at(seconds_since_epoch).to_s end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
286 287 288 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 286 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
292 293 294 295 296 297 298 299 300 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 292 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
280 281 282 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 280 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
174 175 176 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 174 def valid? true end |