Class: XeroRuby::Accounting::BankTransaction
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::BankTransaction
- Defined in:
- lib/xero-ruby/models/accounting/bank_transaction.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Constant Summary collapse
- RECEIVE =
"RECEIVE".freeze
- RECEIVE_OVERPAYMENT =
"RECEIVE-OVERPAYMENT".freeze
- RECEIVE_PREPAYMENT =
"RECEIVE-PREPAYMENT".freeze
- SPEND =
"SPEND".freeze
- SPEND_OVERPAYMENT =
"SPEND-OVERPAYMENT".freeze
- SPEND_PREPAYMENT =
"SPEND-PREPAYMENT".freeze
- RECEIVE_TRANSFER =
"RECEIVE-TRANSFER".freeze
- SPEND_TRANSFER =
"SPEND-TRANSFER".freeze
- AUTHORISED =
"AUTHORISED".freeze
- DELETED =
"DELETED".freeze
- VOIDED =
"VOIDED".freeze
Instance Attribute Summary collapse
-
#bank_account ⇒ Object
Returns the value of attribute bank_account.
-
#bank_transaction_id ⇒ Object
Xero generated unique identifier for bank transaction.
-
#contact ⇒ Object
Returns the value of attribute contact.
-
#currency_code ⇒ Object
Returns the value of attribute currency_code.
-
#currency_rate ⇒ Object
Exchange rate to base currency when money is spent or received.
-
#date ⇒ Object
Date of transaction – YYYY-MM-DD.
-
#has_attachments ⇒ Object
Boolean to indicate if a bank transaction has an attachment.
-
#is_reconciled ⇒ Object
Boolean to show if transaction is reconciled.
-
#line_amount_types ⇒ Object
Returns the value of attribute line_amount_types.
-
#line_items ⇒ Object
See LineItems.
-
#overpayment_id ⇒ Object
Xero generated unique identifier for an Overpayment.
-
#prepayment_id ⇒ Object
Xero generated unique identifier for a Prepayment.
-
#reference ⇒ Object
Reference for the transaction.
-
#status ⇒ Object
See Bank Transaction Status Codes.
-
#status_attribute_string ⇒ Object
A string to indicate if a invoice status.
-
#sub_total ⇒ Object
Total of bank transaction excluding taxes.
-
#total ⇒ Object
Total of bank transaction tax inclusive.
-
#total_tax ⇒ Object
Total tax on bank transaction.
-
#type ⇒ Object
See Bank Transaction Types.
-
#updated_date_utc ⇒ Object
Last modified date UTC format.
-
#url ⇒ Object
URL link to a source document – shown as “Go to App Name”.
-
#validation_errors ⇒ Object
Displays array of validation error messages from the API.
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 = {}) ⇒ BankTransaction
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 = {}) ⇒ BankTransaction
Initializes the object
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 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 277 278 279 280 281 282 283 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 177 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. = attributes[:'has_attachments'] else self. = 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 |
Instance Attribute Details
#bank_account ⇒ Object
Returns the value of attribute bank_account.
38 39 40 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 38 def bank_account @bank_account end |
#bank_transaction_id ⇒ Object
Xero generated unique identifier for bank transaction
77 78 79 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 77 def bank_transaction_id @bank_transaction_id end |
#contact ⇒ Object
Returns the value of attribute contact.
32 33 34 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 32 def contact @contact end |
#currency_code ⇒ Object
Returns the value of attribute currency_code.
50 51 52 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 50 def currency_code @currency_code end |
#currency_rate ⇒ Object
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.
53 54 55 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 53 def currency_rate @currency_rate end |
#date ⇒ Object
Date of transaction – YYYY-MM-DD
44 45 46 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 44 def date @date end |
#has_attachments ⇒ Object
Boolean to indicate if a bank transaction has an attachment
89 90 91 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 89 def @has_attachments end |
#is_reconciled ⇒ Object
Boolean to show if transaction is reconciled
41 42 43 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 41 def is_reconciled @is_reconciled end |
#line_amount_types ⇒ Object
Returns the value of attribute line_amount_types.
65 66 67 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 65 def line_amount_types @line_amount_types end |
#line_items ⇒ Object
See LineItems
35 36 37 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 35 def line_items @line_items end |
#overpayment_id ⇒ Object
Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT
83 84 85 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 83 def overpayment_id @overpayment_id end |
#prepayment_id ⇒ Object
Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT
80 81 82 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 80 def prepayment_id @prepayment_id end |
#reference ⇒ Object
Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
47 48 49 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 47 def reference @reference end |
#status ⇒ Object
See Bank Transaction Status Codes
59 60 61 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 59 def status @status end |
#status_attribute_string ⇒ Object
A string to indicate if a invoice status
92 93 94 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 92 def status_attribute_string @status_attribute_string end |
#sub_total ⇒ Object
Total of bank transaction excluding taxes
68 69 70 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 68 def sub_total @sub_total end |
#total ⇒ Object
Total of bank transaction tax inclusive
74 75 76 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 74 def total @total end |
#total_tax ⇒ Object
Total tax on bank transaction
71 72 73 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 71 def total_tax @total_tax end |
#type ⇒ Object
See Bank Transaction Types
21 22 23 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 21 def type @type end |
#updated_date_utc ⇒ Object
Last modified date UTC format
86 87 88 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 86 def updated_date_utc @updated_date_utc end |
#url ⇒ Object
URL link to a source document – shown as “Go to App Name”
56 57 58 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 56 def url @url end |
#validation_errors ⇒ Object
Displays array of validation error messages from the API
95 96 97 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 95 def validation_errors @validation_errors end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 120 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 |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
386 387 388 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 386 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
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/bank_transaction.rb', line 148 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 344 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 && == o. && status_attribute_string == o.status_attribute_string && validation_errors == o.validation_errors end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 414 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
481 482 483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 481 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
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 393 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
373 374 375 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 373 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
379 380 381 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 379 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, , status_attribute_string, validation_errors].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 287 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @contact.nil? invalid_properties.push('invalid value for "contact", contact 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 |
#parse_date(datestring) ⇒ Object
customized data_parser
496 497 498 499 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 496 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)
461 462 463 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 461 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
467 468 469 470 471 472 473 474 475 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 467 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
455 456 457 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 455 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/xero-ruby/models/accounting/bank_transaction.rb', line 310 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 @contact.nil? 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 |