Class: ModernTreasury::Models::Invoices::InvoiceLineItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/invoices/invoice_line_item.rb,
sig/modern_treasury/models/invoices/invoice_line_item.rbs

Overview

See Also:

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

Instance Attribute 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 ⇒ Object 



53
 
# File 'sig/modern_treasury/models/invoices/invoice_line_item.rbs', line 53

def initialize: (

Instance Attribute Details

#amount ⇒ Integer

The total amount for this line item specified in the invoice currency's smallest unit.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


18
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 18

required :amount, Integer

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


23
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 23

required :created_at, Time

#description ⇒ String

An optional free-form description of the line item.

Parameters:

  • value (String)

Returns:

  • (String) 


29
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 29

required :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:

  • value (String)

Returns:

  • (String) 


37
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 37

required :direction, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 11

required :id, String

#invoice_id ⇒ String

The ID of the invoice for this line item.

Parameters:

  • value (String)

Returns:

  • (String) 


43
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 43

required :invoice_id, String

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


50
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 50

required :live_mode, ModernTreasury::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}

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

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


57
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 57

required :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) 


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

required :name, String

#object ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


68
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 68

required :object, 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:

  • value (Integer)

Returns:

  • (Integer) 


75
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 75

required :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) 


82
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 82

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:

  • value (String)

Returns:

  • (String) 


90
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 90

required :unit_amount_decimal, String

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


95
 
# File 'lib/modern_treasury/models/invoices/invoice_line_item.rb', line 95

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


70
 
# File 'sig/modern_treasury/models/invoices/invoice_line_item.rbs', line 70

def to_hash: -> {