class CyberSource::Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails
Contains all of the tax-related fields for the invoice.
Attributes
Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ————- |:————-:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. |
Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)
Indicates the type of tax data for the taxDetails object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 28 def self.attribute_map { :'type' => :'type', :'amount' => :'amount', :'rate' => :'rate' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 47 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'rate') self.rate = attributes[:'rate'] end end
Attribute type mapping.
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 37 def self.swagger_types { :'type' => :'String', :'amount' => :'String', :'rate' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 93 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && amount == o.amount && rate == o.rate 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/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 137 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f 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 temp_model = CyberSource.const_get(type).new temp_model.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/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 203 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
Custom attribute writer method with validation @param [Object] amount Value to be assigned
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 81 def amount=(amount) @amount = amount end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 116 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 103 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 109 def hash [type, amount, rate].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 68 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method with validation @param [Object] rate Value to be assigned
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 87 def rate=(rate) @rate = rate end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 189 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 177 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/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb, line 75 def valid? true end