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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::CardPurchaseSupplement::Invoice

Defined in:

lib/increase/models/card_purchase_supplement.rb

Overview

See Also:

• #invoice

Defined Under Namespace

Modules: DiscountTreatmentCode, TaxTreatments

Instance Attribute Summary

• #discount_amount ⇒ Integer^?

  Discount given to cardholder.

• #discount_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the discount.

• #discount_treatment_code ⇒ Symbol, ...

  Indicates how the merchant applied the discount.

• #duty_tax_amount ⇒ Integer^?

  Amount of duty taxes.

• #duty_tax_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the duty tax.

• #order_date ⇒ Date^?

  Date the order was taken.

• #shipping_amount ⇒ Integer^?

  The shipping cost.

• #shipping_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the shipping cost.

• #shipping_destination_country_code ⇒ String^?

  Country code of the shipping destination.

• #shipping_destination_postal_code ⇒ String^?

  Postal code of the shipping destination.

• #shipping_source_postal_code ⇒ String^?

  Postal code of the location being shipped from.

• #shipping_tax_amount ⇒ Integer^?

  Taxes paid for freight and shipping.

• #shipping_tax_currency ⇒ String^?

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the shipping tax.

• #shipping_tax_rate ⇒ String^?

  Tax rate for freight and shipping.

• #tax_treatments ⇒ Symbol, ...

  Indicates how the merchant applied taxes.

• #unique_value_added_tax_invoice_reference ⇒ String^?

  Value added tax invoice reference number.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #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 constructor

  Some parameter documentations has been truncated, see Invoice for more details.

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

Some parameter documentations has been truncated, see Increase::Models::CardPurchaseSupplement::Invoice for more details.

Invoice-level information about the payment.

Parameters:

• discount_amount (Integer, nil) (defaults to: ) —

  Discount given to cardholder.

• discount_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the discount.

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

  Indicates how the merchant applied the discount.

• duty_tax_amount (Integer, nil) (defaults to: ) —

  Amount of duty taxes.

• duty_tax_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the duty tax.

• order_date (Date, nil) (defaults to: ) —

  Date the order was taken.

• shipping_amount (Integer, nil) (defaults to: ) —

  The shipping cost.

• shipping_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the shipping cos

• shipping_destination_country_code (String, nil) (defaults to: ) —

  Country code of the shipping destination.

• shipping_destination_postal_code (String, nil) (defaults to: ) —

  Postal code of the shipping destination.

• shipping_source_postal_code (String, nil) (defaults to: ) —

  Postal code of the location being shipped from.

• shipping_tax_amount (Integer, nil) (defaults to: ) —

  Taxes paid for freight and shipping.

• shipping_tax_currency (String, nil) (defaults to: ) —

  The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the shipping tax

• shipping_tax_rate (String, nil) (defaults to: ) —

  Tax rate for freight and shipping.

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

  Indicates how the merchant applied taxes.

• unique_value_added_tax_invoice_reference (String, nil) (defaults to: ) —

  Value added tax invoice reference number.

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

Instance Attribute Details

#discount_amount ⇒ Integer^?

Discount given to cardholder.

Returns:

• (Integer, nil)

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

required :discount_amount, Integer, nil?: true

#discount_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the discount.

Returns:

• (String, nil)

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

required :discount_currency, String, nil?: true

#discount_treatment_code ⇒ Symbol, ...

Indicates how the merchant applied the discount.

Returns:

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

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

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

#duty_tax_amount ⇒ Integer^?

Amount of duty taxes.

Returns:

• (Integer, nil)

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

required :duty_tax_amount, Integer, nil?: true

#duty_tax_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the duty tax.

Returns:

• (String, nil)

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

required :duty_tax_currency, String, nil?: true

#order_date ⇒ Date^?

Date the order was taken.

Returns:

• (Date, nil)

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

required :order_date, Date, nil?: true

#shipping_amount ⇒ Integer^?

The shipping cost.

Returns:

• (Integer, nil)

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

required :shipping_amount, Integer, nil?: true

#shipping_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the shipping cost.

Returns:

• (String, nil)

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

required :shipping_currency, String, nil?: true

#shipping_destination_country_code ⇒ String^?

Country code of the shipping destination.

Returns:

• (String, nil)

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

required :shipping_destination_country_code, String, nil?: true

#shipping_destination_postal_code ⇒ String^?

Postal code of the shipping destination.

Returns:

• (String, nil)

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

required :shipping_destination_postal_code, String, nil?: true

#shipping_source_postal_code ⇒ String^?

Postal code of the location being shipped from.

Returns:

• (String, nil)

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

required :shipping_source_postal_code, String, nil?: true

#shipping_tax_amount ⇒ Integer^?

Taxes paid for freight and shipping.

Returns:

• (Integer, nil)

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

required :shipping_tax_amount, Integer, nil?: true

#shipping_tax_currency ⇒ String^?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the shipping tax.

Returns:

• (String, nil)

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

required :shipping_tax_currency, String, nil?: true

#shipping_tax_rate ⇒ String^?

Tax rate for freight and shipping.

Returns:

• (String, nil)

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

required :shipping_tax_rate, String, nil?: true

#tax_treatments ⇒ Symbol, ...

Indicates how the merchant applied taxes.

Returns:

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

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

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

#unique_value_added_tax_invoice_reference ⇒ String^?

Value added tax invoice reference number.

Returns:

• (String, nil)

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

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 222