Class: Orb::Models::InvoiceCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/invoice_create_params.rb,
sig/orb/models/invoice_create_params.rbs

Overview

See Also:

  • Orb::Resources::Invoices#create

Defined Under Namespace

Modules: DueDate Classes: LineItem

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 ⇒ Object 



50
 
# File 'sig/orb/models/invoice_create_params.rbs', line 50

def initialize: (

Instance Attribute Details

#auto_collection ⇒ Boolean?

Determines whether this invoice will automatically attempt to charge a saved payment method, if any. If not specified, the invoice inherits the customer's auto_collection setting.

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


36
 
# File 'lib/orb/models/invoice_create_params.rb', line 36

optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true

#currency ⇒ String

An ISO 4217 currency string. Must be the same as the customer's currency if it is set.

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/orb/models/invoice_create_params.rb', line 15

required :currency, String

#customer_id ⇒ String?

The id of the Customer to create this invoice for. One of customer_id and external_customer_id are required.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


43
 
# File 'lib/orb/models/invoice_create_params.rb', line 43

optional :customer_id, String, nil?: true

#discount ⇒ Orb::Models::PercentageDiscount, ...

An optional discount to attach to the invoice.

Parameters:

  • value (Orb::Models::discount, nil)

Returns:



49
 
# File 'lib/orb/models/invoice_create_params.rb', line 49

optional :discount, union: -> { Orb::Discount }, nil?: true

#due_date ⇒ Date, ...

An optional custom due date for the invoice. If not set, the due date will be calculated based on the net_terms value.

Parameters:

  • value (Orb::Models::InvoiceCreateParams::due_date, nil)

Returns:

  • (Date, Time, nil) 


56
 
# File 'lib/orb/models/invoice_create_params.rb', line 56

optional :due_date, union: -> { Orb::InvoiceCreateParams::DueDate }, nil?: true

#external_customer_id ⇒ String?

The external_customer_id of the Customer to create this invoice for. One of customer_id and external_customer_id are required.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


63
 
# File 'lib/orb/models/invoice_create_params.rb', line 63

optional :external_customer_id, String, nil?: true

#invoice_date ⇒ Time

An ISO 8601 date or timestamp, interpreted in the customer's timezone. Must be in the past. If a date is set without a time, invoice_date is set to midnight on the chosen date in the customer's timezone.

Parameters:

  • value (Time)

Returns:

  • (Time) 


23
 
# File 'lib/orb/models/invoice_create_params.rb', line 23

required :invoice_date, Time

#line_items ⇒ Array<Orb::Models::InvoiceCreateParams::LineItem>

Parameters:

  • value (::Array[Orb::InvoiceCreateParams::LineItem])

Returns:



28
 
# File 'lib/orb/models/invoice_create_params.rb', line 28

required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::InvoiceCreateParams::LineItem] }

#memo ⇒ String?

An optional memo to attach to the invoice. If no memo is provided, we will attach the default memo

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


70
 
# File 'lib/orb/models/invoice_create_params.rb', line 70

optional :memo, String, nil?: true

#metadata ⇒ Hash{Symbol=>String, nil}?

User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Parameters:

  • value (::Hash[Symbol, String?], nil)

Returns:

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


78
 
# File 'lib/orb/models/invoice_create_params.rb', line 78

optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true

#net_terms ⇒ Integer?

The net terms determines the due date of the invoice. Due date is calculated based on the invoice or issuance date, depending on the account's configured due date calculation method. A value of '0' here represents that the invoice is due on issue, whereas a value of '30' represents that the customer has 30 days to pay the invoice. Do not set this field if you want to set a custom due date.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


88
 
# File 'lib/orb/models/invoice_create_params.rb', line 88

optional :net_terms, Integer, nil?: true

#will_auto_issue ⇒ Boolean?

When true, this invoice will be submitted for issuance upon creation. When false, the resulting invoice will require manual review to issue. Defaulted to false.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


96
 
# File 'lib/orb/models/invoice_create_params.rb', line 96

optional :will_auto_issue, Orb::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/invoice_create_params.rb', line 190

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


66
 
# File 'sig/orb/models/invoice_create_params.rbs', line 66

def to_hash: -> {