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

Inherits:
Internal::Type::BaseModel 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

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, dump, fields, hash, #hash, inspect, #inspect, known_fields, optional, required, #to_h, #to_json, #to_s, #to_yaml, walk

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Constructor Details

#initialize(metadata: nil) ⇒ Object

Some parameter documentations has been truncated, see HRIS::PayStatement::Tax::Attributes::Metadata for more details.

Parameters:

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

    The metadata to be attached to the entity by existing rules. It is a key-value p




# File 'lib/finch_api/models/hris/pay_statement.rb', line 414

Instance Attribute Details

#amount ⇒ Integer?

The tax amount in cents.

Returns:

  • (Integer, nil) 


383
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 383

optional :amount, Integer, nil?: true

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

Returns:

  • (FinchAPI::HRIS::PayStatement::Tax::Attributes, nil) 


388
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 388

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

#currency ⇒ String?

The currency code.

Returns:

  • (String, nil) 


394
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 394

optional :currency, String, nil?: true

#employer ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


400
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 400

optional :employer, FinchAPI::Internal::Type::Boolean, nil?: true

#name ⇒ String?

The exact name of tax from the pay statement.

Returns:

  • (String, nil) 


406
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 406

optional :name, String, nil?: true

#type ⇒ Symbol, ...

The type of taxes.

Returns:

  • (Symbol, FinchAPI::HRIS::PayStatement::Tax::Type, nil) 


412
 
# File 'lib/finch_api/models/hris/pay_statement.rb', line 412

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