BambooHR.Company (BambooHR v0.3.0)

Functions for interacting with company information in the BambooHR API.

Summary

Functions

get_eins(client)

Retrieves company EINs (Employer Identification Numbers).

get_information(client)

Retrieves company information.

Functions

get_eins(client)

@spec get_eins(BambooHR.Client.t()) :: BambooHR.Client.response()

Retrieves company EINs (Employer Identification Numbers).

Returns a list of EINs associated with the company.

Parameters

client - Client configuration created with BambooHR.Client.new/1

Examples

iex> BambooHR.Company.get_eins(client)
{:ok, %{
  "eins" => [
    %{"ein" => "12-3456789", "name" => "Acme Corp"},
    %{"ein" => "98-7654321", "name" => "Acme Subsidiary"}
  ]
}}

get_information(client)

@spec get_information(client :: BambooHR.Client.t()) :: BambooHR.Client.response()

Retrieves company information.

Returns basic company details including name, address, and employee count.

Parameters

client - Client configuration created with BambooHR.Client.new/1

Examples

iex> BambooHR.Company.get_information(client)
{:ok, %{
  "name" => "Acme Corp",
  "employeeCount" => 100,
  "city" => "San Francisco"
}}