Class: MetronomeSDK::Models::V1::Customers::InvoiceListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/customers/invoice_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Sort, Type

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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(customer_id:, contract_id: nil, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, starting_on: nil, status: nil, type: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::Customers::InvoiceListParams for more details.

Parameters:

  • customer_id (String)
  • contract_id (String) (defaults to: nil) —

    Only return invoices for the specified contract

  • credit_type_id (String) (defaults to: nil) —

    Only return invoices for the specified credit type

  • ending_before (Time) (defaults to: nil) —

    RFC 3339 timestamp (exclusive). Invoices will only be returned for billing perio

  • limit (Integer) (defaults to: nil) —

    Max number of results that should be returned

  • next_page (String) (defaults to: nil) —

    Cursor that indicates where the next page of results should start.

  • skip_zero_qty_line_items (Boolean) (defaults to: nil) —

    If set, all zero quantity line items will be filtered out of the response

  • sort (Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Sort) (defaults to: nil) —

    Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to date_a

  • starting_on (Time) (defaults to: nil) —

    RFC 3339 timestamp (inclusive). Invoices will only be returned for billing perio

  • status (String) (defaults to: nil) —

    Invoice status, e.g. DRAFT, FINALIZED, or VOID

  • type (Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Type) (defaults to: nil) —

    Filter invoices by type. Defaults to returning all invoice types.

  • request_options (MetronomeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 80

Instance Attribute Details

#contract_id ⇒ String?

Only return invoices for the specified contract

Returns:

  • (String, nil) 


21
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 21

optional :contract_id, String

#credit_type_id ⇒ String?

Only return invoices for the specified credit type

Returns:

  • (String, nil) 


27
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 27

optional :credit_type_id, String

#customer_id ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 15

required :customer_id, String

#ending_before ⇒ Time?

RFC 3339 timestamp (exclusive). Invoices will only be returned for billing periods that end before this time.

Returns:

  • (Time, nil) 


34
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 34

optional :ending_before, Time

#limit ⇒ Integer?

Max number of results that should be returned

Returns:

  • (Integer, nil) 


40
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 40

optional :limit, Integer

#next_page ⇒ String?

Cursor that indicates where the next page of results should start.

Returns:

  • (String, nil) 


46
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 46

optional :next_page, String

#skip_zero_qty_line_items ⇒ Boolean?

If set, all zero quantity line items will be filtered out of the response

Returns:

  • (Boolean, nil) 


52
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 52

optional :skip_zero_qty_line_items, MetronomeSDK::Internal::Type::Boolean

#sort ⇒ Symbol, ...

Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to date_asc.

Returns:



59
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 59

optional :sort, enum: -> { MetronomeSDK::V1::Customers::InvoiceListParams::Sort }

#starting_on ⇒ Time?

RFC 3339 timestamp (inclusive). Invoices will only be returned for billing periods that start at or after this time.

Returns:

  • (Time, nil) 


66
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 66

optional :starting_on, Time

#status ⇒ String?

Invoice status, e.g. DRAFT, FINALIZED, or VOID

Returns:

  • (String, nil) 


72
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 72

optional :status, String

#type ⇒ Symbol, ...

Filter invoices by type. Defaults to returning all invoice types.

Returns:



78
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 78

optional :type, enum: -> { MetronomeSDK::V1::Customers::InvoiceListParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/customers/invoice_list_params.rb', line 116