bexio_api_client
v0.7.0

BexioApiClient.Accounting (bexio_api_client v0.7.0)

Bexio API for the accounting part of the API.

Link to this section Summary

Types

api_error_type()

Functions

fetch_account_groups(req, opts \\ [])

Fetch a list of account groups.

fetch_accounts(req, opts \\ [])

Fetch a list of accounts.

fetch_calendar_years(req, opts \\ [])

Fetch a list of calendar years.

fetch_currencies(req, opts \\ [])

Fetch a list of currencies.

fetch_exchange_rates(req, id, opts \\ [])

Fetch a list of currency exchange rates.

fetch_taxes(req, date \\ nil, types \\ nil, opts \\ [])

Fetch a list of taxes.

search_accounts(req, criteria, opts \\ [])

Search accounts via query. The following search fields are supported

Link to this section Types

Link to this type

api_error_type()

@type api_error_type() :: BexioApiClient.Helpers.api_error_type()

Link to this section Functions

Link to this function

fetch_account_groups(req, opts \\ [])

@spec fetch_account_groups(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Accounting.AccountGroup.t()]} | api_error_type()

Fetch a list of account groups.

Link to this function

fetch_accounts(req, opts \\ [])

@spec fetch_accounts(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Accounting.Account.t()]} | api_error_type()

Fetch a list of accounts.

Link to this function

fetch_calendar_years(req, opts \\ [])

@spec fetch_calendar_years(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Accounting.CalendarYear.t()]} | api_error_type()

Fetch a list of calendar years.

Link to this function

fetch_currencies(req, opts \\ [])

@spec fetch_currencies(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Accounting.Currency.t()]} | api_error_type()

Fetch a list of currencies.

Link to this function

fetch_exchange_rates(req, id, opts \\ [])

@spec fetch_exchange_rates(
  req :: Req.Request.t(),
  id :: integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Accounting.ExchangeRate.t()]} | api_error_type()

Fetch a list of currency exchange rates.

Link to this function

fetch_taxes(req, date \\ nil, types \\ nil, opts \\ [])

@spec fetch_taxes(
  req :: Req.Request.t(),
  date :: Date.t() | nil,
  types :: :sales_tax | :pre_tax | nil,
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Accounting.Tax.t()]} | api_error_type()

Fetch a list of taxes.

Arguments:

  • date - all taxes which are active at the date given
  • types - filter the types of tax (:sales_tax or :pre_tax)
Link to this function

search_accounts(req, criteria, opts \\ [])

@spec search_accounts(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.Accounting.Account.t()]} | api_error_type()

Search accounts via query. The following search fields are supported:

  • account_no
  • fibo_account_group_id (TODO: test this)
  • name
  • account_type