Class: EInvoiceAPI::Models::DocumentCreate::Item::Charge

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/e_invoice_api/models/document_create.rb,
sig/e_invoice_api/models/document_create.rbs

Defined Under Namespace

Modules: Amount, BaseAmount, MultiplierFactor, ReasonCode, TaxCode, TaxRate

Instance Attribute Summary collapse

Class Method 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(amount: nil, base_amount: nil, multiplier_factor: nil, reason: nil, reason_code: nil, tax_code: nil, tax_rate: nil) ⇒ Object

Some parameter documentations has been truncated, see EInvoiceAPI::Models::DocumentCreate::Item::Charge for more details.

A charge is an additional fee for example for late payment, late delivery, etc.

Parameters:

  • amount (Float, String, nil) (defaults to: nil) —

    The charge amount, without VAT. Must be rounded to maximum 2 decimals

  • base_amount (Float, String, nil) (defaults to: nil) —

    The base amount that may be used, in conjunction with the charge percentage, to

  • multiplier_factor (Float, String, nil) (defaults to: nil) —

    The percentage that may be used, in conjunction with the charge base amount, to

  • reason (String, nil) (defaults to: nil) —

    The reason for the charge

  • reason_code (Symbol, EInvoiceAPI::Models::DocumentCreate::Item::Charge::ReasonCode, nil) (defaults to: nil) —

    Charge reason codes for invoice charges and fees

  • tax_code (Symbol, EInvoiceAPI::Models::DocumentCreate::Item::Charge::TaxCode, nil) (defaults to: nil) —

    Duty or tax or fee category codes (Subset of UNCL5305)

  • tax_rate (Float, String, nil) (defaults to: nil) —

    The VAT rate, represented as percentage that applies to the charge




# File 'lib/e_invoice_api/models/document_create.rb', line 1351

Instance Attribute Details

#amount ⇒ Float, ...

The charge amount, without VAT. Must be rounded to maximum 2 decimals

Parameters:

  • value (EInvoiceAPI::Models::DocumentCreate::Item::Charge::amount, nil)

Returns:

  • (Float, String, nil) 


1299
 
# File 'lib/e_invoice_api/models/document_create.rb', line 1299

optional :amount, union: -> { EInvoiceAPI::DocumentCreate::Item::Charge::Amount }, nil?: true

#base_amount ⇒ Float, ...

The base amount that may be used, in conjunction with the charge percentage, to calculate the charge amount. Must be rounded to maximum 2 decimals

Parameters:

  • value (EInvoiceAPI::Models::DocumentCreate::Item::Charge::base_amount, nil)

Returns:

  • (Float, String, nil) 


1306
1307
1308
1309
1310
 
# File 'lib/e_invoice_api/models/document_create.rb', line 1306

optional :base_amount,
union: -> {
  EInvoiceAPI::DocumentCreate::Item::Charge::BaseAmount
},
nil?: true

#multiplier_factor ⇒ Float, ...

The percentage that may be used, in conjunction with the charge base amount, to calculate the charge amount. To state 20%, use value 20

Parameters:

  • value (EInvoiceAPI::Models::DocumentCreate::Item::Charge::multiplier_factor, nil)

Returns:

  • (Float, String, nil) 


1317
1318
1319
 
# File 'lib/e_invoice_api/models/document_create.rb', line 1317

optional :multiplier_factor,
union: -> { EInvoiceAPI::DocumentCreate::Item::Charge::MultiplierFactor },
nil?: true

#reason ⇒ String?

The reason for the charge

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


1325
 
# File 'lib/e_invoice_api/models/document_create.rb', line 1325

optional :reason, String, nil?: true

#reason_code ⇒ Symbol, ...

Charge reason codes for invoice charges and fees

Parameters:

  • value (EInvoiceAPI::Models::DocumentCreate::Item::Charge::reason_code, nil)

Returns:



1331
1332
1333
1334
1335
 
# File 'lib/e_invoice_api/models/document_create.rb', line 1331

optional :reason_code,
enum: -> {
  EInvoiceAPI::DocumentCreate::Item::Charge::ReasonCode
},
nil?: true

#tax_code ⇒ Symbol, ...

Duty or tax or fee category codes (Subset of UNCL5305)

Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL

Parameters:

  • value (EInvoiceAPI::Models::DocumentCreate::Item::Charge::tax_code, nil)

Returns:



1343
 
# File 'lib/e_invoice_api/models/document_create.rb', line 1343

optional :tax_code, enum: -> { EInvoiceAPI::DocumentCreate::Item::Charge::TaxCode }, nil?: true

#tax_rate ⇒ Float, ...

The VAT rate, represented as percentage that applies to the charge

Parameters:

  • value (EInvoiceAPI::Models::DocumentCreate::Item::Charge::tax_rate, nil)

Returns:

  • (Float, String, nil) 


1349
 
# File 'lib/e_invoice_api/models/document_create.rb', line 1349

optional :tax_rate, union: -> { EInvoiceAPI::DocumentCreate::Item::Charge::TaxRate }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/e_invoice_api/models/document_create.rb', line 1600

.variants ⇒ Array(Float, String)

Returns:

  • (Array(Float, String)) 



# File 'lib/e_invoice_api/models/document_create.rb', line 1381

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1175
 
# File 'sig/e_invoice_api/models/document_create.rbs', line 1175

def to_hash: -> {