Class: FinchAPI::Models::HRIS::PayStatement::Tax

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/finch-api/models/hris/pay_statement.rb

Defined Under Namespace

Modules: Type Classes: Attributes

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata: nil) ⇒ Tax

Returns a new instance of Tax.

Parameters:

  • metadata (Hash{Symbol=>Object}) (defaults to: nil) 


8
 
# File 'lib/finch-api/models/hris/pay_statement.rb', line 8

def initialize(amount: nil, attributes: nil, currency: nil, employer: nil, name: nil, type: nil, **) = super

Instance Attribute Details

#amount ⇒ Integer?

The tax amount in cents.

Returns:

  • (Integer, nil) 


413
 
# File 'lib/finch-api/models/hris/pay_statement.rb', line 413

optional :amount, Integer, nil?: true

#attributes ⇒ FinchAPI::Models::HRIS::PayStatement::Tax::Attributes?

Returns:



418
 
# File 'lib/finch-api/models/hris/pay_statement.rb', line 418

optional :attributes, -> { FinchAPI::Models::HRIS::PayStatement::Tax::Attributes }, nil?: true

#currency ⇒ String?

The currency code.

Returns:

  • (String, nil) 


424
 
# File 'lib/finch-api/models/hris/pay_statement.rb', line 424

optional :currency, String, nil?: true

#employer ⇒ Boolean?

‘true` if the amount is paid by the employers.

Returns:

  • (Boolean, nil) 


430
 
# File 'lib/finch-api/models/hris/pay_statement.rb', line 430

optional :employer, FinchAPI::BooleanModel, nil?: true

#metadata=(value) ⇒ Hash{Symbol=>Object} (writeonly)

Returns:

  • (Hash{Symbol=>Object}) 


2
3
4
 
# File 'lib/finch-api/models/hris/pay_statement.rb', line 2

def metadata=(value)
  @metadata = value
end

#name ⇒ String?

The exact name of tax from the pay statement.

Returns:

  • (String, nil) 


436
 
# File 'lib/finch-api/models/hris/pay_statement.rb', line 436

optional :name, String, nil?: true

#type ⇒ Symbol, ...

The type of taxes.

Returns:



442
 
# File 'lib/finch-api/models/hris/pay_statement.rb', line 442

optional :type, enum: -> { FinchAPI::Models::HRIS::PayStatement::Tax::Type }, nil?: true