Class: Increase::Models::CardPurchaseSupplement::Invoice

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/card_purchase_supplement.rb,
sig/increase/models/card_purchase_supplement.rbs

Overview

See Also:

  • Increase::Models::CardPurchaseSupplement#invoice

Defined Under Namespace

Modules: DiscountTreatmentCode, TaxTreatments

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(discount_amount:, discount_currency:, discount_treatment_code:, duty_tax_amount:, duty_tax_currency:, order_date:, shipping_amount:, shipping_currency:, shipping_destination_country_code:, shipping_destination_postal_code:, shipping_source_postal_code:, shipping_tax_amount:, shipping_tax_currency:, shipping_tax_rate:, tax_treatments:, unique_value_added_tax_invoice_reference:) ⇒ Object

Invoice-level information about the payment.

Parameters:

  • discount_amount (Integer, nil) —

    Discount given to cardholder.

  • discount_currency (String, nil) —

    The ISO 4217 code for the discount.

  • discount_treatment_code (Symbol, Increase::Models::CardPurchaseSupplement::Invoice::DiscountTreatmentCode, nil) —

    Indicates how the merchant applied the discount.

  • duty_tax_amount (Integer, nil) —

    Amount of duty taxes.

  • duty_tax_currency (String, nil) —

    The ISO 4217 code for the duty tax.

  • order_date (Date, nil) —

    Date the order was taken.

  • shipping_amount (Integer, nil) —

    The shipping cost.

  • shipping_currency (String, nil) —

    The ISO 4217 code for the shipping cost.

  • shipping_destination_country_code (String, nil) —

    Country code of the shipping destination.

  • shipping_destination_postal_code (String, nil) —

    Postal code of the shipping destination.

  • shipping_source_postal_code (String, nil) —

    Postal code of the location being shipped from.

  • shipping_tax_amount (Integer, nil) —

    Taxes paid for freight and shipping.

  • shipping_tax_currency (String, nil) —

    The ISO 4217 code for the shipping tax.

  • shipping_tax_rate (String, nil) —

    Tax rate for freight and shipping.

  • tax_treatments (Symbol, Increase::Models::CardPurchaseSupplement::Invoice::TaxTreatments, nil) —

    Indicates how the merchant applied taxes.

  • unique_value_added_tax_invoice_reference (String, nil) —

    Value added tax invoice reference number.




# File 'lib/increase/models/card_purchase_supplement.rb', line 179

Instance Attribute Details

#discount_amount ⇒ Integer?

Discount given to cardholder.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


81
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 81

required :discount_amount, Integer, nil?: true

#discount_currency ⇒ String?

The ISO 4217 code for the discount.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


87
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 87

required :discount_currency, String, nil?: true

#discount_treatment_code ⇒ Symbol, ...

Indicates how the merchant applied the discount.

Parameters:

  • value (Increase::Models::CardPurchaseSupplement::Invoice::discount_treatment_code, nil)

Returns:



93
94
95
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 93

required :discount_treatment_code,
enum: -> { Increase::CardPurchaseSupplement::Invoice::DiscountTreatmentCode },
nil?: true

#duty_tax_amount ⇒ Integer?

Amount of duty taxes.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


101
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 101

required :duty_tax_amount, Integer, nil?: true

#duty_tax_currency ⇒ String?

The ISO 4217 code for the duty tax.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


107
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 107

required :duty_tax_currency, String, nil?: true

#order_date ⇒ Date?

Date the order was taken.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


113
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 113

required :order_date, Date, nil?: true

#shipping_amount ⇒ Integer?

The shipping cost.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


119
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 119

required :shipping_amount, Integer, nil?: true

#shipping_currency ⇒ String?

The ISO 4217 code for the shipping cost.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


126
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 126

required :shipping_currency, String, nil?: true

#shipping_destination_country_code ⇒ String?

Country code of the shipping destination.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


132
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 132

required :shipping_destination_country_code, String, nil?: true

#shipping_destination_postal_code ⇒ String?

Postal code of the shipping destination.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


138
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 138

required :shipping_destination_postal_code, String, nil?: true

#shipping_source_postal_code ⇒ String?

Postal code of the location being shipped from.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


144
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 144

required :shipping_source_postal_code, String, nil?: true

#shipping_tax_amount ⇒ Integer?

Taxes paid for freight and shipping.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


150
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 150

required :shipping_tax_amount, Integer, nil?: true

#shipping_tax_currency ⇒ String?

The ISO 4217 code for the shipping tax.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


157
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 157

required :shipping_tax_currency, String, nil?: true

#shipping_tax_rate ⇒ String?

Tax rate for freight and shipping.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


163
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 163

required :shipping_tax_rate, String, nil?: true

#tax_treatments ⇒ Symbol, ...

Indicates how the merchant applied taxes.

Parameters:

  • value (Increase::Models::CardPurchaseSupplement::Invoice::tax_treatments, nil)

Returns:



169
170
171
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 169

required :tax_treatments,
enum: -> { Increase::CardPurchaseSupplement::Invoice::TaxTreatments },
nil?: true

#unique_value_added_tax_invoice_reference ⇒ String?

Value added tax invoice reference number.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


177
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 177

required :unique_value_added_tax_invoice_reference, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/card_purchase_supplement.rb', line 237

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


121
 
# File 'sig/increase/models/card_purchase_supplement.rbs', line 121

def to_hash: -> {