class XeroRuby::Accounting::BankTransaction
Constants
- AUTHORISED
- DELETED
- RECEIVE
- RECEIVE_OVERPAYMENT
- RECEIVE_PREPAYMENT
- RECEIVE_TRANSFER
- SPEND
- SPEND_OVERPAYMENT
- SPEND_PREPAYMENT
- SPEND_TRANSFER
- VOIDED
Attributes
Xero generated unique identifier for bank transaction
Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments.
Date of transaction – YYYY-MM-DD
Boolean to indicate if a bank transaction has an attachment
Boolean to show if transaction is reconciled
See LineItems
Xero generated unique identifier for an Overpayment
. This will be returned on BankTransactions
with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT
Xero generated unique identifier for a Prepayment
. This will be returned on BankTransactions
with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT
See Bank Transaction Status Codes
A string to indicate if a invoice status
Total of bank transaction excluding taxes
Total of bank transaction tax inclusive
Total tax on bank transaction
See Bank Transaction Types
Last modified date UTC format
URL link to a source document – shown as “Go to App Name”
Displays array of validation error messages from the API
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/accounting/bank_transaction.rb, line 119 def self.attribute_map { :'type' => :'Type', :'contact' => :'Contact', :'line_items' => :'LineItems', :'bank_account' => :'BankAccount', :'is_reconciled' => :'IsReconciled', :'date' => :'Date', :'reference' => :'Reference', :'currency_code' => :'CurrencyCode', :'currency_rate' => :'CurrencyRate', :'url' => :'Url', :'status' => :'Status', :'line_amount_types' => :'LineAmountTypes', :'sub_total' => :'SubTotal', :'total_tax' => :'TotalTax', :'total' => :'Total', :'bank_transaction_id' => :'BankTransactionID', :'prepayment_id' => :'PrepaymentID', :'overpayment_id' => :'OverpaymentID', :'updated_date_utc' => :'UpdatedDateUTC', :'has_attachments' => :'HasAttachments', :'status_attribute_string' => :'StatusAttributeString', :'validation_errors' => :'ValidationErrors' } 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/bank_transaction.rb, line 380 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/bank_transaction.rb, line 176 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::BankTransaction` 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::BankTransaction`. 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?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'contact') self.contact = attributes[:'contact'] end if attributes.key?(:'line_items') if (value = attributes[:'line_items']).is_a?(Array) self.line_items = value end end if attributes.key?(:'bank_account') self.bank_account = attributes[:'bank_account'] end if attributes.key?(:'is_reconciled') self.is_reconciled = attributes[:'is_reconciled'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'reference') self.reference = attributes[:'reference'] end if attributes.key?(:'currency_code') self.currency_code = attributes[:'currency_code'] end if attributes.key?(:'currency_rate') self.currency_rate = attributes[:'currency_rate'] end if attributes.key?(:'url') self.url = attributes[:'url'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'line_amount_types') self.line_amount_types = attributes[:'line_amount_types'] end if attributes.key?(:'sub_total') self.sub_total = attributes[:'sub_total'] end if attributes.key?(:'total_tax') self.total_tax = attributes[:'total_tax'] end if attributes.key?(:'total') self.total = attributes[:'total'] end if attributes.key?(:'bank_transaction_id') self.bank_transaction_id = attributes[:'bank_transaction_id'] end if attributes.key?(:'prepayment_id') self.prepayment_id = attributes[:'prepayment_id'] end if attributes.key?(:'overpayment_id') self.overpayment_id = attributes[:'overpayment_id'] end if attributes.key?(:'updated_date_utc') self.updated_date_utc = attributes[:'updated_date_utc'] end if attributes.key?(:'has_attachments') self.has_attachments = attributes[:'has_attachments'] else self.has_attachments = false end if attributes.key?(:'status_attribute_string') self.status_attribute_string = attributes[:'status_attribute_string'] end if attributes.key?(:'validation_errors') if (value = attributes[:'validation_errors']).is_a?(Array) self.validation_errors = value end end end
Attribute type mapping.
# File lib/xero-ruby/models/accounting/bank_transaction.rb, line 147 def self.openapi_types { :'type' => :'String', :'contact' => :'Contact', :'line_items' => :'Array<LineItem>', :'bank_account' => :'Account', :'is_reconciled' => :'Boolean', :'date' => :'Date', :'reference' => :'String', :'currency_code' => :'CurrencyCode', :'currency_rate' => :'BigDecimal', :'url' => :'String', :'status' => :'String', :'line_amount_types' => :'LineAmountTypes', :'sub_total' => :'BigDecimal', :'total_tax' => :'BigDecimal', :'total' => :'BigDecimal', :'bank_transaction_id' => :'String', :'prepayment_id' => :'String', :'overpayment_id' => :'String', :'updated_date_utc' => :'DateTime', :'has_attachments' => :'Boolean', :'status_attribute_string' => :'String', :'validation_errors' => :'Array<ValidationError>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/bank_transaction.rb, line 338 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && contact == o.contact && line_items == o.line_items && bank_account == o.bank_account && is_reconciled == o.is_reconciled && date == o.date && reference == o.reference && currency_code == o.currency_code && currency_rate == o.currency_rate && url == o.url && status == o.status && line_amount_types == o.line_amount_types && sub_total == o.sub_total && total_tax == o.total_tax && total == o.total && bank_transaction_id == o.bank_transaction_id && prepayment_id == o.prepayment_id && overpayment_id == o.overpayment_id && updated_date_utc == o.updated_date_utc && has_attachments == o.has_attachments && status_attribute_string == o.status_attribute_string && validation_errors == o.validation_errors 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/bank_transaction.rb, line 408 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/bank_transaction.rb, line 481 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/bank_transaction.rb, line 387 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/bank_transaction.rb, line 367 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/accounting/bank_transaction.rb, line 373 def hash [type, contact, line_items, bank_account, is_reconciled, date, reference, currency_code, currency_rate, url, status, line_amount_types, sub_total, total_tax, total, bank_transaction_id, prepayment_id, overpayment_id, updated_date_utc, has_attachments, status_attribute_string, validation_errors].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/bank_transaction.rb, line 286 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @line_items.nil? invalid_properties.push('invalid value for "line_items", line_items cannot be nil.') end if @bank_account.nil? invalid_properties.push('invalid value for "bank_account", bank_account cannot be nil.') end invalid_properties end
# File lib/xero-ruby/models/accounting/bank_transaction.rb, line 497 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
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/xero-ruby/models/accounting/bank_transaction.rb, line 328 def status=(status) validator = EnumAttributeValidator.new('String', ["AUTHORISED", "DELETED", "VOIDED"]) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/accounting/bank_transaction.rb, line 473 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/bank_transaction.rb, line 461 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/bank_transaction.rb, line 449 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/xero-ruby/models/accounting/bank_transaction.rb, line 318 def type=(type) validator = EnumAttributeValidator.new('String', ["RECEIVE", "RECEIVE-OVERPAYMENT", "RECEIVE-PREPAYMENT", "SPEND", "SPEND-OVERPAYMENT", "SPEND-PREPAYMENT", "RECEIVE-TRANSFER", "SPEND-TRANSFER"]) unless validator.valid?(type) fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." end @type = type 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/bank_transaction.rb, line 305 def valid? return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["RECEIVE", "RECEIVE-OVERPAYMENT", "RECEIVE-PREPAYMENT", "SPEND", "SPEND-OVERPAYMENT", "SPEND-PREPAYMENT", "RECEIVE-TRANSFER", "SPEND-TRANSFER"]) return false unless type_validator.valid?(@type) return false if @line_items.nil? return false if @bank_account.nil? status_validator = EnumAttributeValidator.new('String', ["AUTHORISED", "DELETED", "VOIDED"]) return false unless status_validator.valid?(@status) true end