Class: MetronomeSDK::Models::V1::Customers::Invoice

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/customers/invoice.rb,
sig/metronome_sdk/models/v1/customers/invoice.rbs

Overview

See Also:

  • MetronomeSDK::Resources::V1::Customers::Invoices#list

Direct Known Subclasses

InvoiceListBreakdownsResponse

Defined Under Namespace

Classes: ConstituentInvoice, CorrectionRecord, ExternalInvoice, InvoiceAdjustment, LineItem, Payer, ResellerRoyalty, RevenueSystemInvoice

Instance Attribute 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(gcp_account_id: nil, gcp_offer_id: nil) ⇒ Object

Parameters:

  • gcp_account_id (String) (defaults to: nil)
  • gcp_offer_id (String) (defaults to: nil) 



# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 888

Instance Attribute Details

#amendment_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


48
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 48

optional :amendment_id, String

#billable_status ⇒ Object?

This field's availability is dependent on your client's configuration.

Parameters:

  • (top)

Returns:

  • (Object, nil) 


54
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 54

optional :billable_status, MetronomeSDK::Internal::Type::Unknown

#constituent_invoices ⇒ Array<MetronomeSDK::Models::V1::Customers::Invoice::ConstituentInvoice>?

Required on invoices with type USAGE_CONSOLIDATED. List of constituent invoices that were consolidated to create this invoice.

Returns:



61
62
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 61

optional :constituent_invoices,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice] }

#contract_custom_fields ⇒ Hash{Symbol=>String}?

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Returns:

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


68
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 68

optional :contract_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#contract_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


73
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 73

optional :contract_id, String

#correction_record ⇒ MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord?

Returns:



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

optional :correction_record, -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord }

#created_at ⇒ Time?

When the invoice was created (UTC). This field is present for correction invoices only.

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


85
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 85

optional :created_at, Time

#credit_type ⇒ MetronomeSDK::Models::CreditTypeData

Parameters:

Returns:



17
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 17

required :credit_type, -> { MetronomeSDK::CreditTypeData }

#custom_fields ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


90
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 90

optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]

#customer_custom_fields ⇒ Hash{Symbol=>String}?

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Returns:

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


96
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 96

optional :customer_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#customer_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 22

required :customer_id, String

#end_timestamp ⇒ Time?

End of the usage period this invoice covers (UTC)

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


102
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 102

optional :end_timestamp, Time

#external_invoice ⇒ MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice?

Parameters:

  • value (MetronomeSDK::V1::Customers::Invoice::ExternalInvoice, nil)

Returns:



107
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 107

optional :external_invoice, -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice }, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


12
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 12

required :id, String

#invoice_adjustments ⇒ Array<MetronomeSDK::Models::V1::Customers::Invoice::InvoiceAdjustment>?

Returns:



112
113
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 112

optional :invoice_adjustments,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::InvoiceAdjustment] }

#issued_at ⇒ Time?

When the invoice was issued (UTC)

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


119
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 119

optional :issued_at, Time

#line_items ⇒ Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem>

Parameters:

  • value (::Array[MetronomeSDK::V1::Customers::Invoice::LineItem])

Returns:



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

required :line_items,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::LineItem] }

#net_payment_terms_days ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


124
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 124

optional :net_payment_terms_days, Float

#netsuite_sales_order_id ⇒ String?

This field's availability is dependent on your client's configuration.

Parameters:

  • (String)

Returns:

  • (String, nil) 


130
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 130

optional :netsuite_sales_order_id, String

#payer ⇒ MetronomeSDK::Models::V1::Customers::Invoice::Payer?

Required for account hierarchy usage invoices. An object containing the contract and customer UUIDs that pay for this invoice.

Returns:



137
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 137

optional :payer, -> { MetronomeSDK::V1::Customers::Invoice::Payer }

#plan_custom_fields ⇒ Hash{Symbol=>String}?

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Returns:

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


143
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 143

optional :plan_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#plan_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


148
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 148

optional :plan_id, String

#plan_name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


153
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 153

optional :plan_name, String

#regenerated_from_invoice_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


158
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 158

optional :regenerated_from_invoice_id, String

#reseller_royalty ⇒ MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty?

Only present for contract invoices with reseller royalties.

Returns:



164
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 164

optional :reseller_royalty, -> { MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty }

#revenue_system_invoices ⇒ Array<MetronomeSDK::Models::V1::Customers::Invoice::RevenueSystemInvoice>?

Parameters:

  • value (::Array[MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice], nil)

Returns:



169
170
171
172
173
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 169

optional :revenue_system_invoices,
-> {
  MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice]
},
nil?: true

#salesforce_opportunity_id ⇒ String?

This field's availability is dependent on your client's configuration.

Parameters:

  • (String)

Returns:

  • (String, nil) 


179
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 179

optional :salesforce_opportunity_id, String

#start_timestamp ⇒ Time?

Beginning of the usage period this invoice covers (UTC)

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


185
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 185

optional :start_timestamp, Time

#status ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


33
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 33

required :status, String

#subtotal ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


190
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 190

optional :subtotal, Float

#total ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


38
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 38

required :total, Float

#type ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


43
 
# File 'lib/metronome_sdk/models/v1/customers/invoice.rb', line 43

required :type, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


203
 
# File 'sig/metronome_sdk/models/v1/customers/invoice.rbs', line 203

def to_hash: -> {