class XeroRuby::Accounting::JournalLine
Attributes
See Accounts
See Accounts
See AccountCodes
The description from the source transaction line item. Only returned if populated.
Gross amount of journal line (NetAmount + TaxAmount).
Xero identifier for Journal
Net amount of journal line. This will be a positive value for a debit and negative for a credit
Total tax on a journal line
see TaxRates
The tax type from TaxRates
Optional Tracking Category – see Tracking. Any JournalLine
can have a maximum of 2 <TrackingCategory> elements.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/accounting/journal_line.rb, line 56 def self.attribute_map { :'journal_line_id' => :'JournalLineID', :'account_id' => :'AccountID', :'account_code' => :'AccountCode', :'account_type' => :'AccountType', :'account_name' => :'AccountName', :'description' => :'Description', :'net_amount' => :'NetAmount', :'gross_amount' => :'GrossAmount', :'tax_amount' => :'TaxAmount', :'tax_type' => :'TaxType', :'tax_name' => :'TaxName', :'tracking_categories' => :'TrackingCategories' } 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/journal_line.rb, line 204 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/journal_line.rb, line 93 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::JournalLine` 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::JournalLine`. 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?(:'journal_line_id') self.journal_line_id = attributes[:'journal_line_id'] end if attributes.key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'account_code') self.account_code = attributes[:'account_code'] end if attributes.key?(:'account_type') self.account_type = attributes[:'account_type'] end if attributes.key?(:'account_name') self.account_name = attributes[:'account_name'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'net_amount') self.net_amount = attributes[:'net_amount'] end if attributes.key?(:'gross_amount') self.gross_amount = attributes[:'gross_amount'] end if attributes.key?(:'tax_amount') self.tax_amount = attributes[:'tax_amount'] end if attributes.key?(:'tax_type') self.tax_type = attributes[:'tax_type'] end if attributes.key?(:'tax_name') self.tax_name = attributes[:'tax_name'] end if attributes.key?(:'tracking_categories') if (value = attributes[:'tracking_categories']).is_a?(Array) self.tracking_categories = value end end end
Attribute type mapping.
# File lib/xero-ruby/models/accounting/journal_line.rb, line 74 def self.openapi_types { :'journal_line_id' => :'String', :'account_id' => :'String', :'account_code' => :'String', :'account_type' => :'AccountType', :'account_name' => :'String', :'description' => :'String', :'net_amount' => :'BigDecimal', :'gross_amount' => :'BigDecimal', :'tax_amount' => :'BigDecimal', :'tax_type' => :'String', :'tax_name' => :'String', :'tracking_categories' => :'Array<TrackingCategory>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/journal_line.rb, line 172 def ==(o) return true if self.equal?(o) self.class == o.class && journal_line_id == o.journal_line_id && account_id == o.account_id && account_code == o.account_code && account_type == o.account_type && account_name == o.account_name && description == o.description && net_amount == o.net_amount && gross_amount == o.gross_amount && tax_amount == o.tax_amount && tax_type == o.tax_type && tax_name == o.tax_name && tracking_categories == o.tracking_categories 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/journal_line.rb, line 232 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/journal_line.rb, line 305 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/journal_line.rb, line 211 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/journal_line.rb, line 191 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/accounting/journal_line.rb, line 197 def hash [journal_line_id, account_id, account_code, account_type, account_name, description, net_amount, gross_amount, tax_amount, tax_type, tax_name, tracking_categories].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/journal_line.rb, line 159 def list_invalid_properties invalid_properties = Array.new invalid_properties end
# File lib/xero-ruby/models/accounting/journal_line.rb, line 321 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/journal_line.rb, line 297 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/journal_line.rb, line 285 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/journal_line.rb, line 273 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/journal_line.rb, line 166 def valid? true end