Class: ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem

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

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(amount:, accounting_category_id: nil, description: nil, metadata: nil) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::ExpectedPaymentCreateParams::LineItem for more details.

Parameters:

  • amount (Integer) —

    Value in specified currency's smallest unit. e.g. $10 would be represented as 10

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

    The ID of one of your accounting categories. Note that these will only be access

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

    A free-form description of the line item.

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

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




# File 'lib/modern_treasury/models/expected_payment_create_params.rb', line 297

Instance Attribute Details

#accounting_category_id ⇒ String?

The ID of one of your accounting categories. Note that these will only be accessible if your accounting system has been connected.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


282
 
# File 'lib/modern_treasury/models/expected_payment_create_params.rb', line 282

optional :accounting_category_id, String, nil?: true

#amount ⇒ Integer

Value in specified currency's smallest unit. e.g. $10 would be represented as 1000.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


275
 
# File 'lib/modern_treasury/models/expected_payment_create_params.rb', line 275

required :amount, Integer

#description ⇒ String?

A free-form description of the line item.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


288
 
# File 'lib/modern_treasury/models/expected_payment_create_params.rb', line 288

optional :description, String, nil?: true

#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) 


295
 
# File 'lib/modern_treasury/models/expected_payment_create_params.rb', line 295

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


211
 
# File 'sig/modern_treasury/models/expected_payment_create_params.rbs', line 211

def to_hash: -> {