class XeroRuby::Accounting::BatchPayment
Constants
- AUTHORISED
- DELETED
- PAYBATCH
- RECBATCH
Attributes
The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00
The Xero generated unique identifier for the bank transaction (read-only)
(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.
Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
Date the payment is being made (YYYY-MM-DD) e.g. 2009-09-06
(Non-NZ Only) These details are sent to the org’s bank as a reference for the batch payment transaction. They will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement imported into Xero. Maximum field length = 18
Booelan that tells you if the batch payment has been reconciled (read-only)
(UK Only) Only shows on the statement line in Xero. Max length =18
(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.
An array of payments
(NZ Only) Optional references for the batch payment transaction. It will also show with the batch payment transaction in the bank reconciliation Find & Match screen. Depending on your individual bank, the detail may also show on the bank statement you import into Xero.
AUTHORISED
or DELETED
(read-only). New batch payments will have a status of AUTHORISED
. It is not possible to delete batch payments via the API.
The total of the payments that make up the batch (read-only)
UTC timestamp of last update to the payment
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/batch_payment.rb, line 97 def self.attribute_map { :'account' => :'Account', :'reference' => :'Reference', :'particulars' => :'Particulars', :'code' => :'Code', :'details' => :'Details', :'narrative' => :'Narrative', :'batch_payment_id' => :'BatchPaymentID', :'date_string' => :'DateString', :'date' => :'Date', :'amount' => :'Amount', :'payments' => :'Payments', :'type' => :'Type', :'status' => :'Status', :'total_amount' => :'TotalAmount', :'updated_date_utc' => :'UpdatedDateUTC', :'is_reconciled' => :'IsReconciled', :'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/batch_payment.rb, line 366 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/batch_payment.rb, line 144 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::BatchPayment` 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::BatchPayment`. 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?(:'account') self.account = attributes[:'account'] end if attributes.key?(:'reference') self.reference = attributes[:'reference'] end if attributes.key?(:'particulars') self.particulars = attributes[:'particulars'] end if attributes.key?(:'code') self.code = attributes[:'code'] end if attributes.key?(:'details') self.details = attributes[:'details'] end if attributes.key?(:'narrative') self.narrative = attributes[:'narrative'] end if attributes.key?(:'batch_payment_id') self.batch_payment_id = attributes[:'batch_payment_id'] end if attributes.key?(:'date_string') self.date_string = attributes[:'date_string'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'payments') if (value = attributes[:'payments']).is_a?(Array) self.payments = value end end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'total_amount') self.total_amount = attributes[:'total_amount'] end if attributes.key?(:'updated_date_utc') self.updated_date_utc = attributes[:'updated_date_utc'] end if attributes.key?(:'is_reconciled') self.is_reconciled = attributes[:'is_reconciled'] 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/batch_payment.rb, line 120 def self.openapi_types { :'account' => :'Account', :'reference' => :'String', :'particulars' => :'String', :'code' => :'String', :'details' => :'String', :'narrative' => :'String', :'batch_payment_id' => :'String', :'date_string' => :'String', :'date' => :'Date', :'amount' => :'BigDecimal', :'payments' => :'Array<Payment>', :'type' => :'String', :'status' => :'String', :'total_amount' => :'String', :'updated_date_utc' => :'DateTime', :'is_reconciled' => :'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/batch_payment.rb, line 329 def ==(o) return true if self.equal?(o) self.class == o.class && account == o.account && reference == o.reference && particulars == o.particulars && code == o.code && details == o.details && narrative == o.narrative && batch_payment_id == o.batch_payment_id && date_string == o.date_string && date == o.date && amount == o.amount && payments == o.payments && type == o.type && status == o.status && total_amount == o.total_amount && updated_date_utc == o.updated_date_utc && is_reconciled == o.is_reconciled && 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/batch_payment.rb, line 394 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/batch_payment.rb, line 467 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/batch_payment.rb, line 373 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
Custom attribute writer method with validation @param [Object] code Value to be assigned
# File lib/xero-ruby/models/accounting/batch_payment.rb, line 289 def code=(code) if !code.nil? && code.to_s.length > 12 fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 12.' end @code = code end
@see the `==` method @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/batch_payment.rb, line 353 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/accounting/batch_payment.rb, line 359 def hash [account, reference, particulars, code, details, narrative, batch_payment_id, date_string, date, amount, payments, type, status, total_amount, updated_date_utc, is_reconciled, 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/batch_payment.rb, line 232 def list_invalid_properties invalid_properties = Array.new if !@reference.nil? && @reference.to_s.length > 255 invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 255.') end if !@particulars.nil? && @particulars.to_s.length > 12 invalid_properties.push('invalid value for "particulars", the character length must be smaller than or equal to 12.') end if !@code.nil? && @code.to_s.length > 12 invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 12.') end if !@narrative.nil? && @narrative.to_s.length > 18 invalid_properties.push('invalid value for "narrative", the character length must be smaller than or equal to 18.') end invalid_properties end
Custom attribute writer method with validation @param [Object] narrative Value to be assigned
# File lib/xero-ruby/models/accounting/batch_payment.rb, line 299 def narrative=(narrative) if !narrative.nil? && narrative.to_s.length > 18 fail ArgumentError, 'invalid value for "narrative", the character length must be smaller than or equal to 18.' end @narrative = narrative end
# File lib/xero-ruby/models/accounting/batch_payment.rb, line 483 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 with validation @param [Object] particulars Value to be assigned
# File lib/xero-ruby/models/accounting/batch_payment.rb, line 279 def particulars=(particulars) if !particulars.nil? && particulars.to_s.length > 12 fail ArgumentError, 'invalid value for "particulars", the character length must be smaller than or equal to 12.' end @particulars = particulars end
Custom attribute writer method with validation @param [Object] reference Value to be assigned
# File lib/xero-ruby/models/accounting/batch_payment.rb, line 269 def reference=(reference) if !reference.nil? && reference.to_s.length > 255 fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 255.' end @reference = reference end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/xero-ruby/models/accounting/batch_payment.rb, line 319 def status=(status) validator = EnumAttributeValidator.new('String', ["AUTHORISED", "DELETED"]) 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/batch_payment.rb, line 459 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/batch_payment.rb, line 447 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/batch_payment.rb, line 435 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/batch_payment.rb, line 309 def type=(type) validator = EnumAttributeValidator.new('String', ["PAYBATCH", "RECBATCH"]) 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/batch_payment.rb, line 255 def valid? return false if !@reference.nil? && @reference.to_s.length > 255 return false if !@particulars.nil? && @particulars.to_s.length > 12 return false if !@code.nil? && @code.to_s.length > 12 return false if !@narrative.nil? && @narrative.to_s.length > 18 type_validator = EnumAttributeValidator.new('String', ["PAYBATCH", "RECBATCH"]) return false unless type_validator.valid?(@type) status_validator = EnumAttributeValidator.new('String', ["AUTHORISED", "DELETED"]) return false unless status_validator.valid?(@status) true end