Class: FinchAPI::Resources::HRIS::PayStatements

Inherits:
Object
  • Object
show all
Defined in:
lib/finch_api/resources/hris/pay_statements.rb,
sig/finch_api/resources/hris/pay_statements.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PayStatements

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of PayStatements.

Parameters:



45
46
47
 
# File 'lib/finch_api/resources/hris/pay_statements.rb', line 45

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve_many(requests:, entity_ids: nil, request_options: {}) ⇒ FinchAPI::Internal::ResponsesPage<FinchAPI::Models::HRIS::PayStatementResponse>

Some parameter documentations has been truncated, see Models::HRIS::PayStatementRetrieveManyParams for more details.

Read detailed pay statements for each individual.

Deduction and contribution types are supported by the payroll systems that supports Benefits.

Parameters:

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/finch_api/resources/hris/pay_statements.rb', line 26

def retrieve_many(params)
  query_params = [:entity_ids]
  parsed, options = FinchAPI::HRIS::PayStatementRetrieveManyParams.dump_request(params)
  query = FinchAPI::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: "employer/pay-statement",
    query: query,
    body: parsed.except(*query_params),
    page: FinchAPI::Internal::ResponsesPage,
    model: FinchAPI::HRIS::PayStatementResponse,
    security: {bearer_auth: true},
    options: options
  )
end