Codat.Accounting.CompanyInfo (codat v1.0.0)

Copy Markdown View Source

Read company information from the accounting platform.

Summary

Functions

Fetches company info from the accounting platform.

Queues a refresh of company info.

Functions

get(client_or_company_id, id_or_opts \\ [])

@spec get(Codat.Client.t() | String.t(), String.t() | keyword()) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Fetches company info from the accounting platform.

Example

{:ok, info} = Codat.Accounting.CompanyInfo.get(client, "company-id")
info["companyName"]  # => "Acme Corp"
info["baseCurrency"] # => "GBP"

refresh(client_or_company_id, id_or_opts \\ [])

@spec refresh(Codat.Client.t() | String.t(), String.t() | keyword()) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Queues a refresh of company info.