Module: ModernTreasury::Models::InvoiceListParams::Status

Extended by:
Internal::Type::Enum
Defined in:
lib/modern_treasury/models/invoice_list_params.rb

Constant Summary collapse

DRAFT =
:draft
:paid
PARTIALLY_PAID =
:partially_paid
PAYMENT_PENDING =
:payment_pending
UNPAID =
:unpaid
VOIDED =
:voided

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/modern_treasury/models/invoice_list_params.rb', line 125


Instance Method Details

#initialize(after_cursor: nil, counterparty_id: nil, created_at_end: nil, created_at_start: nil, due_date_end: nil, due_date_start: nil, expected_payment_id: nil, metadata: nil, number: nil, originating_account_id: nil, payment_order_id: nil, per_page: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:

  • after_cursor (String, nil) (defaults to: nil)
  • counterparty_id (String) (defaults to: nil)
  • created_at_end (Time) (defaults to: nil)

    An inclusive upper bound for searching created_at

  • created_at_start (Time) (defaults to: nil)

    An inclusive lower bound for searching created_at

  • due_date_end (Date) (defaults to: nil)

    An inclusive upper bound for searching due_date

  • due_date_start (Date) (defaults to: nil)

    An inclusive lower bound for searching due_date

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

    For example, if you want to query for records with metadata key ‘Type` and value

  • number (String) (defaults to: nil)

    A unique record number assigned to each invoice that is issued.

  • originating_account_id (String) (defaults to: nil)
  • payment_order_id (String) (defaults to: nil)
  • per_page (Integer) (defaults to: nil)
  • status (Symbol, ModernTreasury::Models::InvoiceListParams::Status) (defaults to: nil)
  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/modern_treasury/models/invoice_list_params.rb', line 115

module Status
  extend ModernTreasury::Internal::Type::Enum

  DRAFT = :draft
  PAID = :paid
  PARTIALLY_PAID = :partially_paid
  PAYMENT_PENDING = :payment_pending
  UNPAID = :unpaid
  VOIDED = :voided

  # @!method self.values
  #   @return [Array<Symbol>]
end