Class: Stigg::Models::V1::CustomerListInvoicesResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::CustomerListInvoicesResponse

Defined in:

lib/stigg/models/v1/customer_list_invoices_response.rb,
sig/stigg/models/v1/customer_list_invoices_response.rbs

Overview

See Also:

• Stigg::Resources::V1::Customers#list_invoices

Defined Under Namespace

Modules: State Classes: LineItem

Instance Attribute Summary

• #contract_external_id ⇒ String^?

  External ID of the contract the invoice belongs to: your contract ref when mapped, otherwise the Received contract ID.

• #currency ⇒ String^?

  The ISO-4217 currency code of the invoice.

• #customer_external_id ⇒ String^?

  External ID of the customer the invoice belongs to: your customer ref when mapped, otherwise the Received customer ID.

• #discount ⇒ Float^?

  The total discount amount.

• #due_date ⇒ Time^?

  The date payment is due.

• #invoice_external_id ⇒ String^?

  External ID for the invoice: the mapped external ID when one exists, otherwise the invoice ID.

• #invoice_id ⇒ String

  The billing provider (Received) invoice ID.

• #invoice_number ⇒ String^?

  The invoice document number (or draft number while the invoice is unissued).

• #issue_date ⇒ Time^?

  The date the invoice was issued.

• #line_items ⇒ Array<Stigg::Models::V1::CustomerListInvoicesResponse::LineItem>

  The invoice line items.

• #paid_date ⇒ Time^?

  The date the invoice was reconciled as paid; present once reconciled.

• #state ⇒ Symbol, Stigg::Models::V1::CustomerListInvoicesResponse::State

  The invoice status (open, paid, or canceled).

• #subtotal ⇒ Float^?

  The pre-tax subtotal.

• #tax ⇒ Float^?

  The total tax amount.

• #total ⇒ Float^?

  The total amount due.

Instance Method Summary

• #initialize(amount:, description:, product_external_id:, quantity:, unit_price:) ⇒ Object constructor

  A single line item on an invoice.

• #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(amount:, description:, product_external_id:, quantity:, unit_price:) ⇒ Object

A single line item on an invoice.

Parameters:

• amount (Float, nil) —

  Total amount for this line (unit price × quantity)

• description (String, nil) —

  Human-readable description of the line item

• product_external_id (String, nil) —

  External ID of the product this line item relates to, when one is mapped

• quantity (Float, nil) —

  Quantity billed on this line

• unit_price (Float, nil) —

  Price per unit for this line

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 170

Instance Attribute Details

#contract_external_id ⇒ String^?

External ID of the contract the invoice belongs to: your contract ref when mapped, otherwise the Received contract ID

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 13

required :contract_external_id, String, api_name: :contractExternalId, nil?: true

#currency ⇒ String^?

The ISO-4217 currency code of the invoice

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 19

required :currency, String, nil?: true

#customer_external_id ⇒ String^?

External ID of the customer the invoice belongs to: your customer ref when mapped, otherwise the Received customer ID

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 26

required :customer_external_id, String, api_name: :customerExternalId, nil?: true

#discount ⇒ Float^?

The total discount amount

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 32

required :discount, Float, nil?: true

#due_date ⇒ Time^?

The date payment is due

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 38

required :due_date, Time, api_name: :dueDate, nil?: true

#invoice_external_id ⇒ String^?

External ID for the invoice: the mapped external ID when one exists, otherwise the invoice ID

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 45

required :invoice_external_id, String, api_name: :invoiceExternalId, nil?: true

#invoice_id ⇒ String

The billing provider (Received) invoice ID

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 51

required :invoice_id, String, api_name: :invoiceId

#invoice_number ⇒ String^?

The invoice document number (or draft number while the invoice is unissued)

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 57

required :invoice_number, String, api_name: :invoiceNumber, nil?: true

#issue_date ⇒ Time^?

The date the invoice was issued

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 63

required :issue_date, Time, api_name: :issueDate, nil?: true

#line_items ⇒ Array<Stigg::Models::V1::CustomerListInvoicesResponse::LineItem>

The invoice line items

Parameters:

• value (::Array[Stigg::Models::V1::CustomerListInvoicesResponse::LineItem])

Returns:

• (Array<Stigg::Models::V1::CustomerListInvoicesResponse::LineItem>)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 69

required :line_items,
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::CustomerListInvoicesResponse::LineItem] },
api_name: :lineItems

#paid_date ⇒ Time^?

The date the invoice was reconciled as paid; present once reconciled

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 77

required :paid_date, Time, api_name: :paidDate, nil?: true

#state ⇒ Symbol, Stigg::Models::V1::CustomerListInvoicesResponse::State

The invoice status (open, paid, or canceled)

Parameters:

• value (Stigg::Models::V1::CustomerListInvoicesResponse::state)

Returns:

• (Symbol, Stigg::Models::V1::CustomerListInvoicesResponse::State)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 83

required :state, enum: -> { Stigg::Models::V1::CustomerListInvoicesResponse::State }

#subtotal ⇒ Float^?

The pre-tax subtotal

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 89

required :subtotal, Float, nil?: true

#tax ⇒ Float^?

The total tax amount

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 95

required :tax, Float, nil?: true

#total ⇒ Float^?

The total amount due

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/stigg/models/v1/customer_list_invoices_response.rb', line 101

required :total, Float, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/stigg/models/v1/customer_list_invoices_response.rbs', line 72

def to_hash: -> {