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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::Customers::Invoice

Defined in:

lib/metronome_sdk/models/v1/customers/invoice.rb

Overview

See Also:

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

Direct Known Subclasses

InvoiceListBreakdownsResponse

Defined Under Namespace

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

Instance Attribute Summary

• #amendment_id ⇒ String^?
• #billable_status ⇒ Object^?

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

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

  Account hierarchy M3 - Required on invoices with type USAGE_CONSOLIDATED.

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

  Custom fields to be added eg.

• #contract_id ⇒ String^?
• #correction_record ⇒ MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord^?
• #created_at ⇒ Time^?

  When the invoice was created (UTC).

• #credit_type ⇒ MetronomeSDK::Models::CreditTypeData
• #custom_fields ⇒ Hash{Symbol=>Object}^?
• #customer_custom_fields ⇒ Hash{Symbol=>String}^?

  Custom fields to be added eg.

• #customer_id ⇒ String
• #end_timestamp ⇒ Time^?

  End of the usage period this invoice covers (UTC).

• #external_invoice ⇒ MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice^?
• #id ⇒ String
• #invoice_adjustments ⇒ Array<MetronomeSDK::Models::V1::Customers::Invoice::InvoiceAdjustment>^?
• #issued_at ⇒ Time^?

  When the invoice was issued (UTC).

• #line_items ⇒ Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem>
• #net_payment_terms_days ⇒ Float^?
• #netsuite_sales_order_id ⇒ String^?

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

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

  Account hierarchy M3 - Required for account hierarchy usage invoices.

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

  Custom fields to be added eg.

• #plan_id ⇒ String^?
• #plan_name ⇒ String^?
• #reseller_royalty ⇒ MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty^?

  Only present for contract invoices with reseller royalties.

• #salesforce_opportunity_id ⇒ String^?

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

• #start_timestamp ⇒ Time^?

  Beginning of the usage period this invoice covers (UTC).

• #status ⇒ String
• #subtotal ⇒ Float^?
• #total ⇒ Float
• #type ⇒ String

Instance Method Summary

• #initialize(contract_id: , customer_id: ) ⇒ Object constructor

  Account hierarchy M3 - Required for account hierarchy usage invoices.

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(contract_id: , customer_id: ) ⇒ Object

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

Parameters:

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

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

Instance Attribute Details

#amendment_id ⇒ String^?

Returns:

• (String, nil)

# 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.

Returns:

• (Object, nil)

# 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>^?

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

Returns:

• (Array<MetronomeSDK::Models::V1::Customers::Invoice::ConstituentInvoice>, nil)

# 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)

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

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

#contract_id ⇒ String^?

Returns:

• (String, nil)

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

optional :contract_id, String

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

Returns:

• (MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord, nil)

# 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.

Returns:

• (Time, nil)

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

optional :created_at, Time

#credit_type ⇒ MetronomeSDK::Models::CreditTypeData

Returns:

• (MetronomeSDK::Models::CreditTypeData)

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

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

#custom_fields ⇒ Hash{Symbol=>Object}^?

Returns:

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

# 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)

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

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

#customer_id ⇒ String

Returns:

• (String)

# 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)

Returns:

• (Time, nil)

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

optional :end_timestamp, Time

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

Returns:

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

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

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

#id ⇒ String

Returns:

• (String)

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

required :id, String

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

Returns:

• (Array<MetronomeSDK::Models::V1::Customers::Invoice::InvoiceAdjustment>, nil)

# 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)

Returns:

• (Time, nil)

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

optional :issued_at, Time

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

Returns:

• (Array<MetronomeSDK::Models::V1::Customers::Invoice::LineItem>)

# 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^?

Returns:

• (Float, nil)

# 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.

Returns:

• (String, nil)

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

optional :netsuite_sales_order_id, String

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

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

Returns:

• (MetronomeSDK::Models::V1::Customers::Invoice::Payer, nil)

# 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)

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

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

#plan_id ⇒ String^?

Returns:

• (String, nil)

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

optional :plan_id, String

#plan_name ⇒ String^?

Returns:

• (String, nil)

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

optional :plan_name, String

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

Only present for contract invoices with reseller royalties.

Returns:

• (MetronomeSDK::Models::V1::Customers::Invoice::ResellerRoyalty, nil)

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

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

#salesforce_opportunity_id ⇒ String^?

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

Returns:

• (String, nil)

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

optional :salesforce_opportunity_id, String

#start_timestamp ⇒ Time^?

Beginning of the usage period this invoice covers (UTC)

Returns:

• (Time, nil)

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

optional :start_timestamp, Time

#status ⇒ String

Returns:

• (String)

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

required :status, String

#subtotal ⇒ Float^?

Returns:

• (Float, nil)

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

optional :subtotal, Float

#total ⇒ Float

Returns:

• (Float)

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

required :total, Float

#type ⇒ String

Returns:

• (String)

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

required :type, String