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.
-
#account_id ⇒ Object
The associated account ID related to this line item.
-
#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, downcase: false) ⇒ 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
-
#to_attributes ⇒ Object
Returns the object in the form of hash with snake_case.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash(downcase: false) ⇒ 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
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 164 165 166 167 168 169 170 171 172 173 |
# 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 |
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 @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 @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 - ACCPAY 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_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
53 54 55 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 53 def discount_rate @discount_rate 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 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)
47 48 49 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 47 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
59 60 61 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 59 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.
44 45 46 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 44 def tax_amount @tax_amount 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 |
#tracking ⇒ Object
Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.
50 51 52 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 50 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.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# 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 |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
224 225 226 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 224 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# 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 |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# 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 |
#_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
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
# 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# 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 |
#eql?(o) ⇒ Boolean
211 212 213 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 211 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
217 218 219 |
# 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 |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
177 178 179 180 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 177 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#parse_date(datestring) ⇒ Object
341 342 343 344 345 346 347 348 349 350 351 352 |
# 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 |
#to_attributes ⇒ Object
Returns the object in the form of hash with snake_case
317 318 319 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 317 def to_attributes to_hash(downcase: true) end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
299 300 301 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 299 def to_body to_hash end |
#to_hash(downcase: false) ⇒ Hash
Returns the object in the form of hash
305 306 307 308 309 310 311 312 313 314 |
# 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 |
#to_s ⇒ String
Returns the string representation of the object
293 294 295 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 293 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
184 185 186 |
# File 'lib/xero-ruby/models/accounting/line_item.rb', line 184 def valid? true end |