Class: VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse

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

Overview

See Also:

  • VitableConnect::Resources::Employers#list_payroll_deduction_statements

Defined Under Namespace

Modules: DeductionFrequency

Instance Attribute 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(csv_file_url:, deduction_frequency:, deduction_frequency_label:, employee_count:, period_end:, period_start:, run_date:, statement_id:, total_deduction_cents:) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse for more details.

One payroll-deduction statement row.

Reads a :class:PayrollDeductionStatementDTO by attribute: the statement_id character field renders the prefixed id via str(), and the date/datetime fields emit ISO-8601 strings.

Parameters:

  • csv_file_url (String, nil) —

    Download link for the change CSV, or null.

  • deduction_frequency (Symbol, VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency) —
    • weekly - Weekly
  • deduction_frequency_label (String) —

    Human-readable deduction frequency (e.g. Monthly).

  • employee_count (Integer) —

    Distinct employees covered by the statement's entries.

  • period_end (Date) —

    Deduction period end date.

  • period_start (Date) —

    Deduction period start date.

  • run_date (Time) —

    When the statement was generated.

  • statement_id (String) —

    Prefixed payroll-deduction-statement identifier (pstmt_<base64-encoded-uuid>).

  • total_deduction_cents (Integer) —

    Total payroll deduction for the period, in cents.




# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 65

Instance Attribute Details

#csv_file_url ⇒ String?

Download link for the change CSV, or null.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


11
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 11

required :csv_file_url, String, nil?: true

#deduction_frequency ⇒ Symbol, VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency

  • weekly - Weekly
  • bi_weekly - Bi Weekly
  • semi_monthly - Semi Monthly
  • monthly - Monthly

Parameters:

  • value (VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::deduction_frequency)

Returns:



20
21
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 20

required :deduction_frequency,
enum: -> { VitableConnect::Models::EmployerListPayrollDeductionStatementsResponse::DeductionFrequency }

#deduction_frequency_label ⇒ String

Human-readable deduction frequency (e.g. Monthly).

Parameters:

  • value (String)

Returns:

  • (String) 


27
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 27

required :deduction_frequency_label, String

#employee_count ⇒ Integer

Distinct employees covered by the statement's entries.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


33
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 33

required :employee_count, Integer

#period_end ⇒ Date

Deduction period end date.

Parameters:

  • value (Date)

Returns:

  • (Date) 


39
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 39

required :period_end, Date

#period_start ⇒ Date

Deduction period start date.

Parameters:

  • value (Date)

Returns:

  • (Date) 


45
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 45

required :period_start, Date

#run_date ⇒ Time

When the statement was generated.

Parameters:

  • value (Time)

Returns:

  • (Time) 


51
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 51

required :run_date, Time

#statement_id ⇒ String

Prefixed payroll-deduction-statement identifier (pstmt_<base64-encoded-uuid>).

Parameters:

  • value (String)

Returns:

  • (String) 


57
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 57

required :statement_id, String

#total_deduction_cents ⇒ Integer

Total payroll deduction for the period, in cents.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


63
 
# File 'lib/vitable_connect/models/employer_list_payroll_deduction_statements_response.rb', line 63

required :total_deduction_cents, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


47
 
# File 'sig/vitable_connect/models/employer_list_payroll_deduction_statements_response.rbs', line 47

def to_hash: -> {