Class: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/metronome_sdk/models/v1/customers/invoice.rb,
sig/metronome_sdk/models/v1/customers/invoice.rbs

Overview

See Also:

• MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord#corrected_external_invoice

Defined Under Namespace

Modules: BillingProviderType, ExternalStatus Classes: Tax

Instance Attribute Summary

• #billing_provider_error ⇒ String^?

  Error message from the billing provider, if available.

• #billing_provider_type ⇒ Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType
• #external_payment_id ⇒ String^?

  The ID of the payment in the external system, if available.

• #external_status ⇒ Symbol, ...
• #invoice_id ⇒ String^?
• #invoiced_sub_total ⇒ Float^?

  The subtotal amount invoiced, if available from the billing provider.

• #invoiced_total ⇒ Float^?

  The total amount invoiced, if available from the billing provider.

• #issued_at_timestamp ⇒ Time^?
• #pdf_url ⇒ String^?

  A URL to the PDF of the invoice, if available from the billing provider.

• #tax ⇒ MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax^?

  Tax details for the invoice, if available from the billing provider.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(billing_provider_type:, billing_provider_error: nil, external_payment_id: nil, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil) ⇒ Object constructor
• #to_hash ⇒ {

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(billing_provider_type:, billing_provider_error: nil, external_payment_id: nil, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil) ⇒ Object

Parameters:

• billing_provider_type (Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType)
• billing_provider_error (String) (defaults to: nil) —

  Error message from the billing provider, if available.

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

  The ID of the payment in the external system, if available.

• external_status (Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus) (defaults to: nil)
• invoice_id (String) (defaults to: nil)
• invoiced_sub_total (Float) (defaults to: nil) —

  The subtotal amount invoiced, if available from the billing provider.

• invoiced_total (Float) (defaults to: nil) —

  The total amount invoiced, if available from the billing provider.

• issued_at_timestamp (Time) (defaults to: nil)
• pdf_url (String) (defaults to: nil) —

  A URL to the PDF of the invoice, if available from the billing provider.

• tax (MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax) (defaults to: nil) —

  Tax details for the invoice, if available from the billing provider.

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

Instance Attribute Details

#billing_provider_error ⇒ String^?

Error message from the billing provider, if available.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :billing_provider_error, String

#billing_provider_type ⇒ Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType

Parameters:

• value (MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::billing_provider_type)

Returns:

• (Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType)

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

required :billing_provider_type,
enum: -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType }

#external_payment_id ⇒ String^?

The ID of the payment in the external system, if available.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :external_payment_id, String

#external_status ⇒ Symbol, ...

Returns:

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

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

optional :external_status,
enum: -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus }

#invoice_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :invoice_id, String

#invoiced_sub_total ⇒ Float^?

The subtotal amount invoiced, if available from the billing provider.

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :invoiced_sub_total, Float

#invoiced_total ⇒ Float^?

The total amount invoiced, if available from the billing provider.

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :invoiced_total, Float

#issued_at_timestamp ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

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

optional :issued_at_timestamp, Time

#pdf_url ⇒ String^?

A URL to the PDF of the invoice, if available from the billing provider.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :pdf_url, String

#tax ⇒ MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax^?

Tax details for the invoice, if available from the billing provider.

Returns:

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

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

optional :tax,
-> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {