Module: PaylocityWebService::Client::Companies

Included in:
PaylocityWebService::Client
Defined in:
lib/paylocity_web_service/client/companies.rb

Constant Summary collapse

CodeResources = 
%W(costCenter1 costCenter2 costCenter3 deductions earnings taxes paygrade positions)

Instance Method Summary collapse

Instance Method Details

#code_resources ⇒ Object 



23
24
25
 
# File 'lib/paylocity_web_service/client/companies.rb', line 23

def code_resources
  CodeResources
end

#company_codes(code_resource) ⇒ Object

Available Code Resources:

  • costCenter1

  • costCenter2

  • costCenter3

  • deductions

  • earnings

  • taxes

  • paygrade

  • positions



19
20
21
 
# File 'lib/paylocity_web_service/client/companies.rb', line 19

def company_codes(code_resource)
  get("/api/v2/companies/#{company_id}/codes/#{code_resource}")
end

#company_connected? ⇒ Boolean

Paylocity hasn’t provide a way to check the connectivity of the API, we have to fire a request to check it.

Returns:

  • (Boolean) 


28
29
30
31
32
33
34
 
# File 'lib/paylocity_web_service/client/companies.rb', line 28

def company_connected?
  return true if company_codes('costCenter1').status == 200
  return true if company_schema.code == 200
  false
rescue => e
  false 
end

#company_schema ⇒ Object 



6
7
8
 
# File 'lib/paylocity_web_service/client/companies.rb', line 6

def company_schema
  get("/api/v2/companies/#{company_id}/openapi")
end