Class: EInvoiceAPI::Models::DocumentResponse::Allowance

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/e_invoice_api/models/document_response.rb

Defined Under Namespace

Modules: ReasonCode, TaxCode

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::DocumentResponse::Allowance for more details.

Parameters:

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

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

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

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

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

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

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

    The reason for the allowance

  • reason_code (Symbol, EInvoiceAPI::Models::DocumentResponse::Allowance::ReasonCode, nil) (defaults to: nil) —

    Allowance reason codes for invoice discounts and charges

  • tax_code (Symbol, EInvoiceAPI::Models::DocumentResponse::Allowance::TaxCode) (defaults to: nil) —

    The VAT category code that applies to the allowance

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

    The VAT rate, represented as percentage that applies to the allowance. Must be r



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/e_invoice_api/models/document_response.rb', line 413

class Allowance < EInvoiceAPI::Internal::Type::BaseModel
  # @!attribute amount
  #   The allowance amount, without VAT. Must be rounded to maximum 2 decimals
  #
  #   @return [String, nil]
  optional :amount, String, nil?: true

  # @!attribute base_amount
  #   The base amount that may be used, in conjunction with the allowance percentage,
  #   to calculate the allowance amount. Must be rounded to maximum 2 decimals
  #
  #   @return [String, nil]
  optional :base_amount, String, nil?: true

  # @!attribute multiplier_factor
  #   The percentage that may be used, in conjunction with the allowance base amount,
  #   to calculate the allowance amount. To state 20%, use value 20. Must be rounded
  #   to maximum 2 decimals
  #
  #   @return [String, nil]
  optional :multiplier_factor, String, nil?: true

  # @!attribute reason
  #   The reason for the allowance
  #
  #   @return [String, nil]
  optional :reason, String, nil?: true

  # @!attribute reason_code
  #   Allowance reason codes for invoice discounts and charges
  #
  #   @return [Symbol, EInvoiceAPI::Models::DocumentResponse::Allowance::ReasonCode, nil]
  optional :reason_code, enum: -> { EInvoiceAPI::DocumentResponse::Allowance::ReasonCode }, nil?: true

  # @!attribute tax_code
  #   The VAT category code that applies to the allowance
  #
  #   @return [Symbol, EInvoiceAPI::Models::DocumentResponse::Allowance::TaxCode, nil]
  optional :tax_code, enum: -> { EInvoiceAPI::DocumentResponse::Allowance::TaxCode }

  # @!attribute tax_rate
  #   The VAT rate, represented as percentage that applies to the allowance. Must be
  #   rounded to maximum 2 decimals
  #
  #   @return [String, nil]
  optional :tax_rate, String, nil?: true

  # @!method initialize(amount: nil, base_amount: nil, multiplier_factor: nil, reason: nil, reason_code: nil, tax_code: nil, tax_rate: nil)
  #   Some parameter documentations has been truncated, see
  #   {EInvoiceAPI::Models::DocumentResponse::Allowance} for more details.
  #
  #   @param amount [String, nil] The allowance amount, without VAT. Must be rounded to maximum 2 decimals
  #
  #   @param base_amount [String, nil] The base amount that may be used, in conjunction with the allowance percentage,
  #
  #   @param multiplier_factor [String, nil] The percentage that may be used, in conjunction with the allowance base amount,
  #
  #   @param reason [String, nil] The reason for the allowance
  #
  #   @param reason_code [Symbol, EInvoiceAPI::Models::DocumentResponse::Allowance::ReasonCode, nil] Allowance reason codes for invoice discounts and charges
  #
  #   @param tax_code [Symbol, EInvoiceAPI::Models::DocumentResponse::Allowance::TaxCode] The VAT category code that applies to the allowance
  #
  #   @param tax_rate [String, nil] The VAT rate, represented as percentage that applies to the allowance. Must be r

  # Allowance reason codes for invoice discounts and charges
  #
  # @see EInvoiceAPI::Models::DocumentResponse::Allowance#reason_code
  module ReasonCode
    extend EInvoiceAPI::Internal::Type::Enum

    REASON_CODE_41 = :"41"
    REASON_CODE_42 = :"42"
    REASON_CODE_60 = :"60"
    REASON_CODE_62 = :"62"
    REASON_CODE_63 = :"63"
    REASON_CODE_64 = :"64"
    REASON_CODE_65 = :"65"
    REASON_CODE_66 = :"66"
    REASON_CODE_67 = :"67"
    REASON_CODE_68 = :"68"
    REASON_CODE_70 = :"70"
    REASON_CODE_71 = :"71"
    REASON_CODE_88 = :"88"
    REASON_CODE_95 = :"95"
    REASON_CODE_100 = :"100"
    REASON_CODE_102 = :"102"
    REASON_CODE_103 = :"103"
    REASON_CODE_104 = :"104"
    REASON_CODE_105 = :"105"

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # The VAT category code that applies to the allowance
  #
  # @see EInvoiceAPI::Models::DocumentResponse::Allowance#tax_code
  module TaxCode
    extend EInvoiceAPI::Internal::Type::Enum

    AE = :AE
    E = :E
    S = :S
    Z = :Z
    G = :G
    O = :O
    K = :K
    L = :L
    M = :M
    B = :B

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#amount ⇒ String?

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

Returns:

  • (String, nil) 


418
 
# File 'lib/e_invoice_api/models/document_response.rb', line 418

optional :amount, String, nil?: true

#base_amount ⇒ String?

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

Returns:

  • (String, nil) 


425
 
# File 'lib/e_invoice_api/models/document_response.rb', line 425

optional :base_amount, String, nil?: true

#multiplier_factor ⇒ String?

The percentage that may be used, in conjunction with the allowance base amount, to calculate the allowance amount. To state 20%, use value 20. Must be rounded to maximum 2 decimals

Returns:

  • (String, nil) 


433
 
# File 'lib/e_invoice_api/models/document_response.rb', line 433

optional :multiplier_factor, String, nil?: true

#reason ⇒ String?

The reason for the allowance

Returns:

  • (String, nil) 


439
 
# File 'lib/e_invoice_api/models/document_response.rb', line 439

optional :reason, String, nil?: true

#reason_code ⇒ Symbol, ...

Allowance reason codes for invoice discounts and charges

Returns:



445
 
# File 'lib/e_invoice_api/models/document_response.rb', line 445

optional :reason_code, enum: -> { EInvoiceAPI::DocumentResponse::Allowance::ReasonCode }, nil?: true

#tax_code ⇒ Symbol, ...

The VAT category code that applies to the allowance

Returns:



451
 
# File 'lib/e_invoice_api/models/document_response.rb', line 451

optional :tax_code, enum: -> { EInvoiceAPI::DocumentResponse::Allowance::TaxCode }

#tax_rate ⇒ String?

The VAT rate, represented as percentage that applies to the allowance. Must be rounded to maximum 2 decimals

Returns:

  • (String, nil) 


458
 
# File 'lib/e_invoice_api/models/document_response.rb', line 458

optional :tax_rate, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/e_invoice_api/models/document_response.rb', line 504