Class: CyberSource::Invoicingv2invoicesOrderInformationAmountDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb

Overview

Contains all of the amount-related fields in the invoice.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoicingv2invoicesOrderInformationAmountDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 84

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?(:'totalAmount')
    self.total_amount = attributes[:'totalAmount']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'discountAmount')
    self.discount_amount = attributes[:'discountAmount']
  end

  if attributes.has_key?(:'discountPercent')
    self.discount_percent = attributes[:'discountPercent']
  end

  if attributes.has_key?(:'subAmount')
    self.sub_amount = attributes[:'subAmount']
  end

  if attributes.has_key?(:'minimumPartialAmount')
    self.minimum_partial_amount = attributes[:'minimumPartialAmount']
  end

  if attributes.has_key?(:'taxDetails')
    self.tax_details = attributes[:'taxDetails']
  end

  if attributes.has_key?(:'freight')
    self.freight = attributes[:'freight']
  end
end

Instance Attribute Details

#currency ⇒ Object

Currency used for the order. Use the three-character [ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by Authorization Required field. **Authorization Reversal** For an authorization reversal (‘reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.



22
23
24
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 22

def currency
  @currency
end

#discount_amount ⇒ Object

Total discount amount applied to the order.



25
26
27
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 25

def discount_amount
  @discount_amount
end

#discount_percent ⇒ Object

The total discount percentage applied to the invoice.



28
29
30
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 28

def discount_percent
  @discount_percent
end

#freight ⇒ Object

Returns the value of attribute freight.



38
39
40
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 38

def freight
  @freight
end

#minimum_partial_amount ⇒ Object

The minimum partial amount required to pay the invoice.



34
35
36
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 34

def minimum_partial_amount
  @minimum_partial_amount
end

#sub_amount ⇒ Object

Sub-amount of the invoice.



31
32
33
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 31

def sub_amount
  @sub_amount
end

#tax_details ⇒ Object

Returns the value of attribute tax_details.



36
37
38
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 36

def tax_details
  @tax_details
end

#total_amount ⇒ Object

Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. Note For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. Important Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - "Authorization Information for Specific Processors" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - "Capture Information for Specific Processors" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - "Credit Information for Specific Processors" in the [Credit Card Services Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see "Zero Amount Authorizations," "Credit Information for Specific Processors" in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or ‘orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in "Authorization Information for Specific Processors" of the [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used.



19
20
21
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 19

def total_amount
  @total_amount
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 41

def self.attribute_map
  {
    :'total_amount' => :'totalAmount',
    :'currency' => :'currency',
    :'discount_amount' => :'discountAmount',
    :'discount_percent' => :'discountPercent',
    :'sub_amount' => :'subAmount',
    :'minimum_partial_amount' => :'minimumPartialAmount',
    :'tax_details' => :'taxDetails',
    :'freight' => :'freight'
  }
end

.json_map ⇒ Object

Attribute mapping from JSON key to ruby-style variable name.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 55

def self.json_map
  {
    :'total_amount' => :'total_amount',
    :'currency' => :'currency',
    :'discount_amount' => :'discount_amount',
    :'discount_percent' => :'discount_percent',
    :'sub_amount' => :'sub_amount',
    :'minimum_partial_amount' => :'minimum_partial_amount',
    :'tax_details' => :'tax_details',
    :'freight' => :'freight'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 69

def self.swagger_types
  {
    :'total_amount' => :'String',
    :'currency' => :'String',
    :'discount_amount' => :'String',
    :'discount_percent' => :'Float',
    :'sub_amount' => :'Float',
    :'minimum_partial_amount' => :'Float',
    :'tax_details' => :'Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails',
    :'freight' => :'Invoicingv2invoicesOrderInformationAmountDetailsFreight'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 156

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_amount == o.total_amount &&
      currency == o.currency &&
      discount_amount == o.discount_amount &&
      discount_percent == o.discount_percent &&
      sub_amount == o.sub_amount &&
      minimum_partial_amount == o.minimum_partial_amount &&
      tax_details == o.tax_details &&
      freight == o.freight
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 205

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 271

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 184

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


171
172
173
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



177
178
179
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 177

def hash
  [total_amount, currency, discount_amount, discount_percent, sub_amount, minimum_partial_amount, tax_details, freight].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



125
126
127
128
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 125

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 251

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



257
258
259
260
261
262
263
264
265
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 257

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

Returns:

  • (String) —

    String presentation of the object



245
246
247
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 245

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



132
133
134
 
# File 'lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb', line 132

def valid?
  true
end