Class: ModernTreasury::Models::Invoices::LineItemCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/invoices/line_item_create_params.rb,
sig/modern_treasury/models/invoices/line_item_create_params.rbs

Overview

See Also:

  • ModernTreasury::Resources::Invoices::LineItems#create

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ModernTreasury

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(invoice_id:, name:, unit_amount:, description: nil, direction: nil, metadata: nil, quantity: nil, unit_amount_decimal: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::Invoices::LineItemCreateParams for more details.

Parameters:

  • invoice_id (String)
  • name (String) —

    The name of the line item, typically a product or SKU name.

  • unit_amount (Integer) —

    The cost per unit of the product or service that this line item is for,

  • description (String) (defaults to: nil) —

    An optional free-form description of the line item.

  • direction (String) (defaults to: nil) —

    Either debit or credit. debit indicates that a client owes the business mo

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Additional data represented as key-value pairs. Both the key and value must be s

  • quantity (Integer) (defaults to: nil) —

    The number of units of a product or service that this line item is for.

  • unit_amount_decimal (String) (defaults to: nil) —

    The cost per unit of the product or service that this line item is for,

  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 65

Instance Attribute Details

#description ⇒ String?

An optional free-form description of the line item.

Parameters:

  • (String)

Returns:

  • (String, nil) 


33
 
# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 33

optional :description, String

#direction ⇒ String?

Either debit or credit. debit indicates that a client owes the business money and increases the invoice's total_amount due. credit has the opposite intention and effect.

Parameters:

  • (String)

Returns:

  • (String, nil) 


41
 
# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 41

optional :direction, String

#invoice_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 14

required :invoice_id, String

#metadata ⇒ Hash{Symbol=>String}?

Additional data represented as key-value pairs. Both the key and value must be strings.

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


48
 
# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 48

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]

#name ⇒ String

The name of the line item, typically a product or SKU name.

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 20

required :name, String

#quantity ⇒ Integer?

The number of units of a product or service that this line item is for. Must be a whole number. Defaults to 1 if not provided.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


55
 
# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 55

optional :quantity, Integer

#unit_amount ⇒ Integer

The cost per unit of the product or service that this line item is for, specified in the invoice currency's smallest unit.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


27
 
# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 27

required :unit_amount, Integer

#unit_amount_decimal ⇒ String?

The cost per unit of the product or service that this line item is for, specified in the invoice currency's smallest unit. Accepts decimal strings with up to 12 decimals

Parameters:

  • (String)

Returns:

  • (String, nil) 


63
 
# File 'lib/modern_treasury/models/invoices/line_item_create_params.rb', line 63

optional :unit_amount_decimal, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


59
 
# File 'sig/modern_treasury/models/invoices/line_item_create_params.rbs', line 59

def to_hash: -> {