Class: ModernTreasury::Models::InvoiceListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::InvoiceListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/invoice_list_params.rb,
sig/modern_treasury/models/invoice_list_params.rbs

Overview

See Also:

• ModernTreasury::Resources::Invoices#list

Defined Under Namespace

Modules: Status

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ModernTreasury

Instance Attribute Summary

• #after_cursor ⇒ String^?
• #counterparty_id ⇒ String^?
• #created_at_end ⇒ Time^?

  An inclusive upper bound for searching created_at.

• #created_at_start ⇒ Time^?

  An inclusive lower bound for searching created_at.

• #due_date_end ⇒ Date^?

  An inclusive upper bound for searching due_date.

• #due_date_start ⇒ Date^?

  An inclusive lower bound for searching due_date.

• #expected_payment_id ⇒ String^?
• #metadata ⇒ Hash{Symbol=>String}^?

  For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan.

• #number ⇒ String^?

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

• #originating_account_id ⇒ String^?
• #payment_order_id ⇒ String^?
• #per_page ⇒ Integer^?
• #status ⇒ Symbol, ...

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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

# File 'sig/modern_treasury/models/invoice_list_params.rbs', line 77

def initialize: (

Instance Attribute Details

#after_cursor ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :after_cursor, String, nil?: true

#counterparty_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :counterparty_id, String

#created_at_end ⇒ Time^?

An inclusive upper bound for searching created_at

Parameters:

• (Time)

Returns:

• (Time, nil)

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

optional :created_at_end, Time

#created_at_start ⇒ Time^?

An inclusive lower bound for searching created_at

Parameters:

• (Time)

Returns:

• (Time, nil)

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

optional :created_at_start, Time

#due_date_end ⇒ Date^?

An inclusive upper bound for searching due_date

Parameters:

• (Date)

Returns:

• (Date, nil)

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

optional :due_date_end, Date

#due_date_start ⇒ Date^?

An inclusive lower bound for searching due_date

Parameters:

• (Date)

Returns:

• (Date, nil)

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

optional :due_date_start, Date

#expected_payment_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :expected_payment_id, String

#metadata ⇒ Hash{Symbol=>String}^?

For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.

Parameters:

• (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String}, nil)

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

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

#number ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :number, String

#originating_account_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :originating_account_id, String

#payment_order_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :payment_order_id, String

#per_page ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

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

optional :per_page, Integer

#status ⇒ Symbol, ...

Returns:

• (Symbol, ModernTreasury::Models::InvoiceListParams::Status, nil)

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

optional :status, enum: -> { ModernTreasury::InvoiceListParams::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/modern_treasury/models/invoice_list_params.rbs', line 94

def to_hash: -> {