Class: FinchAPI::Resources::HRIS::Company

Inherits:
Object
  • Object
show all
Defined in:
lib/finch_api/resources/hris/company.rb,
lib/finch_api/resources/hris/company/pay_statement_item.rb,
lib/finch_api/resources/hris/company/pay_statement_item/rules.rb

Defined Under Namespace

Classes: PayStatementItem

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Company

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 Company.

Parameters:



35
36
37
38
 
# File 'lib/finch_api/resources/hris/company.rb', line 35

def initialize(client:)
  @client = client
  @pay_statement_item = FinchAPI::Resources::HRIS::Company::PayStatementItem.new(client: client)
end

Instance Attribute Details

#pay_statement_item ⇒ FinchAPI::Resources::HRIS::Company::PayStatementItem (readonly)

Returns:



8
9
10
 
# File 'lib/finch_api/resources/hris/company.rb', line 8

def pay_statement_item
  @pay_statement_item
end

Instance Method Details

#retrieve(entity_ids: nil, request_options: {}) ⇒ FinchAPI::Models::HRIS::HRISCompany

Read basic company data

Parameters:

  • entity_ids (Array<String>) —

    The entity IDs to specify which entities’ data to access.

  • request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/finch_api/resources/hris/company.rb', line 21

def retrieve(params = {})
  parsed, options = FinchAPI::HRIS::CompanyRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: "employer/company",
    query: parsed,
    model: FinchAPI::HRIS::HRISCompany,
    options: options
  )
end