Class: Orb::Models::Invoice::CreditNote

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/invoice.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Orb::Internal::Type::BaseModel

Instance Attribute Details

#credit_note_number ⇒ String

Returns:

  • (String) 


554
 
# File 'lib/orb/models/invoice.rb', line 554

required :credit_note_number, String

#id ⇒ String

Returns:

  • (String) 


549
 
# File 'lib/orb/models/invoice.rb', line 549

required :id, String

#memo ⇒ String?

An optional memo supplied on the credit note.

Returns:

  • (String, nil) 


560
 
# File 'lib/orb/models/invoice.rb', line 560

required :memo, String, nil?: true

#reason ⇒ String

Returns:

  • (String) 


565
 
# File 'lib/orb/models/invoice.rb', line 565

required :reason, String

#total ⇒ String

Returns:

  • (String) 


570
 
# File 'lib/orb/models/invoice.rb', line 570

required :total, String

#type ⇒ String

Returns:

  • (String) 


575
 
# File 'lib/orb/models/invoice.rb', line 575

required :type, String

#voided_at ⇒ Time?

If the credit note has a status of ‘void`, this gives a timestamp when the credit note was voided.

Returns:

  • (Time, nil) 


582
 
# File 'lib/orb/models/invoice.rb', line 582

required :voided_at, Time, nil?: true