Class: Orb::Models::CreditNote

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

Defined Under Namespace

Modules: Reason, Type Classes: Discount, LineItem, MaximumAmountAdjustment

Instance Attribute Summary collapse

Class Method 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(id: , name: ) ⇒ Object

Parameters:

  • id (String) (defaults to: )
  • name (String) (defaults to: ) 



# File 'lib/orb/models/credit_note.rb', line 336

Instance Attribute Details

#created_at ⇒ Time

The creation time of the resource in Orb.

Returns:

  • (Time) 


16
 
# File 'lib/orb/models/credit_note.rb', line 16

required :created_at, Time

#credit_note_number ⇒ String

The unique identifier for credit notes.

Returns:

  • (String) 


22
 
# File 'lib/orb/models/credit_note.rb', line 22

required :credit_note_number, String

#credit_note_pdf ⇒ String?

A URL to a PDF of the credit note.

Returns:

  • (String, nil) 


28
 
# File 'lib/orb/models/credit_note.rb', line 28

required :credit_note_pdf, String, nil?: true

#customer ⇒ Orb::Models::CustomerMinified

Returns:



33
 
# File 'lib/orb/models/credit_note.rb', line 33

required :customer, -> { Orb::CustomerMinified }

#discounts ⇒ Array<Orb::Models::CreditNote::Discount>?

Any discounts applied on the original invoice.

Returns:



97
 
# File 'lib/orb/models/credit_note.rb', line 97

optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::Discount] }

#id ⇒ String

The Orb id of this credit note.

Returns:

  • (String) 


10
 
# File 'lib/orb/models/credit_note.rb', line 10

required :id, String

#invoice_id ⇒ String

The id of the invoice resource that this credit note is applied to.

Returns:

  • (String) 


39
 
# File 'lib/orb/models/credit_note.rb', line 39

required :invoice_id, String

#line_items ⇒ Array<Orb::Models::CreditNote::LineItem>

All of the line items associated with this credit note.

Returns:



45
 
# File 'lib/orb/models/credit_note.rb', line 45

required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem] }

#maximum_amount_adjustment ⇒ Orb::Models::CreditNote::MaximumAmountAdjustment?

The maximum amount applied on the original invoice

Returns:



51
 
# File 'lib/orb/models/credit_note.rb', line 51

required :maximum_amount_adjustment, -> { Orb::CreditNote::MaximumAmountAdjustment }, nil?: true

#memo ⇒ String?

An optional memo supplied on the credit note.

Returns:

  • (String, nil) 


57
 
# File 'lib/orb/models/credit_note.rb', line 57

required :memo, String, nil?: true

#minimum_amount_refunded ⇒ String?

Any credited amount from the applied minimum on the invoice.

Returns:

  • (String, nil) 


63
 
# File 'lib/orb/models/credit_note.rb', line 63

required :minimum_amount_refunded, String, nil?: true

#reason ⇒ Symbol, ...

Returns:



68
 
# File 'lib/orb/models/credit_note.rb', line 68

required :reason, enum: -> { Orb::CreditNote::Reason }, nil?: true

#subtotal ⇒ String

The total prior to any creditable invoice-level discounts or minimums.

Returns:

  • (String) 


74
 
# File 'lib/orb/models/credit_note.rb', line 74

required :subtotal, String

#total ⇒ String

The total including creditable invoice-level discounts or minimums, and tax.

Returns:

  • (String) 


80
 
# File 'lib/orb/models/credit_note.rb', line 80

required :total, String

#type ⇒ Symbol, Orb::Models::CreditNote::Type

Returns:



85
 
# File 'lib/orb/models/credit_note.rb', line 85

required :type, enum: -> { Orb::CreditNote::Type }

#voided_at ⇒ Time?

The time at which the credit note was voided in Orb, if applicable.

Returns:

  • (Time, nil) 


91
 
# File 'lib/orb/models/credit_note.rb', line 91

required :voided_at, Time, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/credit_note.rb', line 269