BexioApiClient.Others (bexio_api_client v2.0.0)

Copy Markdown

Bexio API for the other endpoints.

Summary

Types

api_error_type()

Functions

create_country(req, country)

Create a country.

create_fictional_user(req, fictional_user)

Create a fictional user, the id of the fictional user will be ignored!

create_note(req, note)

Create a note.

create_task(req, task)

Create a task.

create_unit(req, name)

Create a unit.

delete_country(req, id)

Delete a country.

delete_fictional_user(req, id)

Create a fictional user

delete_note(req, id)

Delete a note.

delete_task(req, id)

Delete a task.

delete_unit(req, id)

Delete a unit.

edit_country(req, country)

Edit a country.

edit_note(req, note)

Edit a note.

edit_task(req, task)

Edut a task.

edit_unit(req, id, name)

Edit a unit.

enabled(binary)
fetch_company_profile(req, id)

Fetch a single company profile

fetch_company_profiles(req)

Fetch a list of company profiles.

fetch_countries(req)

Fetch a list of countries.

fetch_country(req, id)

Fetch a single country

fetch_document_templates(req)

Fetch a list of document templates.

fetch_fictional_user(req, id)

Fetch a fictional user.

fetch_fictional_users(req)

Fetch a list of fictional users.

fetch_languages(req)

Fetch a list of languages.

fetch_me(req)

Fetch the authenticated user.

fetch_note(req, id)

Fetch a note.

fetch_notes(req, opts \\ [])

Fetch a list of notes.

fetch_payment_types(req, opts \\ [])

Fetch a list of payment types.

fetch_task(req, id)

Fetch a task.

fetch_task_priorities(req, opts \\ [])

Fetch a list of task priorities.

fetch_task_status(req, opts \\ [])

Fetch a list of task status.

fetch_tasks(req, opts \\ [])

Fetch a list of tasks.

fetch_unit(req, id)

Fetch a unit.

fetch_units(req, opts \\ [])

Fetch a list of units.

fetch_user(req, user_id)

Fetch a single user.

fetch_users(req)

Fetch a list of users.

get_access_information(req)

Get access information of logged in user

restriction(binary)
search_countries(req, criteria, opts \\ [])

Search countries via query. The following search fields are supported

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

Search languages via query. The following search fields are supported

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

Search a note

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

Search a payment type

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

Search a task

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

Search a unit

update_fictional_user(req, fictional_user)

Create a fictional user

Types

api_error_type()

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

Functions

create_country(req, country)

@spec create_country(
  req :: Req.Request.t(),
  country :: BexioApiClient.Others.Country.t()
) ::
  {:ok, BexioApiClient.Others.Country.t()} | api_error_type()

Create a country.

create_fictional_user(req, fictional_user)

@spec create_fictional_user(
  req :: Req.Request.t(),
  finctional_user :: BexioApiClient.Others.FictionalUser.t()
) :: {:ok, BexioApiClient.Others.FictionalUser.t()} | api_error_type()

Create a fictional user, the id of the fictional user will be ignored!

create_note(req, note)

@spec create_note(req :: Req.Request.t(), note :: BexioApiClient.Others.Note.t()) ::
  {:ok, Task.t()} | api_error_type()

Create a note.

create_task(req, task)

@spec create_task(req :: Req.Request.t(), task :: Task.t()) ::
  {:ok, Task.t()} | api_error_type()

Create a task.

create_unit(req, name)

@spec create_unit(req :: Req.Request.t(), name :: String.t()) ::
  {:ok, %{id: integer(), name: String.t()}} | api_error_type()

Create a unit.

delete_country(req, id)

@spec delete_country(req :: Req.Request.t(), id :: integer()) ::
  {:ok, boolean()} | api_error_type()

Delete a country.

delete_fictional_user(req, id)

@spec delete_fictional_user(req :: Req.Request.t(), id :: integer()) ::
  {:ok, true | false} | api_error_type()

Create a fictional user

delete_note(req, id)

@spec delete_note(req :: Req.Request.t(), id :: integer()) ::
  {:ok, boolean()} | api_error_type()

Delete a note.

delete_task(req, id)

@spec delete_task(req :: Req.Request.t(), id :: integer()) ::
  {:ok, Task.t()} | api_error_type()

Delete a task.

delete_unit(req, id)

@spec delete_unit(req :: Req.Request.t(), id :: integer()) ::
  {:ok, Task.t()} | api_error_type()

Delete a unit.

edit_country(req, country)

@spec edit_country(
  req :: Req.Request.t(),
  country :: BexioApiClient.Others.Country.t()
) ::
  {:ok, BexioApiClient.Others.Country.t()} | api_error_type()

Edit a country.

edit_note(req, note)

@spec edit_note(req :: Req.Request.t(), note :: BexioApiClient.Others.Note.t()) ::
  {:ok, BexioApiClient.Others.Note.t()} | api_error_type()

Edit a note.

edit_task(req, task)

@spec edit_task(req :: Req.Request.t(), task :: Task.t()) ::
  {:ok, Task.t()} | api_error_type()

Edut a task.

edit_unit(req, id, name)

@spec edit_unit(req :: Req.Request.t(), id :: integer(), name :: String.t()) ::
  {:ok, %{id: integer(), name: String.t()}} | api_error_type()

Edit a unit.

enabled(binary)

fetch_company_profile(req, id)

@spec fetch_company_profile(req :: Req.Request.t(), id :: non_neg_integer()) ::
  {:ok, BexioApiClient.Others.CompanyProfile.t()} | api_error_type()

Fetch a single company profile

fetch_company_profiles(req)

@spec fetch_company_profiles(req :: Req.Request.t()) ::
  {:ok, [BexioApiClient.Others.CompanyProfile.t()]} | api_error_type()

Fetch a list of company profiles.

fetch_countries(req)

@spec fetch_countries(req :: Req.Request.t()) ::
  {:ok, [BexioApiClient.Others.Country.t()]} | api_error_type()

Fetch a list of countries.

fetch_country(req, id)

@spec fetch_country(req :: Req.Request.t(), id :: non_neg_integer()) ::
  {:ok, BexioApiClient.Others.Country.t()} | api_error_type()

Fetch a single country

fetch_document_templates(req)

@spec fetch_document_templates(req :: Req.Request.t()) ::
  {:ok, [BexioApiClient.Others.DocumentTemplate.t()]} | api_error_type()

Fetch a list of document templates.

fetch_fictional_user(req, id)

@spec fetch_fictional_user(req :: Req.Request.t(), id :: integer()) ::
  {:ok, BexioApiClient.Others.FictionalUser.t()} | api_error_type()

Fetch a fictional user.

fetch_fictional_users(req)

@spec fetch_fictional_users(req :: Req.Request.t()) ::
  {:ok, [BexioApiClient.Others.FictionalUser.t()]} | api_error_type()

Fetch a list of fictional users.

fetch_languages(req)

@spec fetch_languages(req :: Req.Request.t()) ::
  {:ok, [BexioApiClient.Others.Language.t()]} | api_error_type()

Fetch a list of languages.

fetch_me(req)

@spec fetch_me(req :: Req.Request.t()) ::
  {:ok, BexioApiClient.Others.User.t()} | api_error_type()

Fetch the authenticated user.

fetch_note(req, id)

@spec fetch_note(req :: Req.Request.t(), id :: integer()) ::
  {:ok, BexioApiClient.Others.Note.t()} | api_error_type()

Fetch a note.

fetch_notes(req, opts \\ [])

@spec fetch_notes(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) ::
  {:ok, [BexioApiClient.Others.Note.t()]} | api_error_type()

Fetch a list of notes.

fetch_payment_types(req, opts \\ [])

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

Fetch a list of payment types.

fetch_task(req, id)

@spec fetch_task(req :: Req.Request.t(), id :: integer()) ::
  {:ok, Task.t()} | api_error_type()

Fetch a task.

fetch_task_priorities(req, opts \\ [])

@spec fetch_task_priorities(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, map()} | api_error_type()

Fetch a list of task priorities.

fetch_task_status(req, opts \\ [])

@spec fetch_task_status(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) ::
  {:ok, map()} | api_error_type()

Fetch a list of task status.

fetch_tasks(req, opts \\ [])

@spec fetch_tasks(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) ::
  {:ok, [Task.t()]} | api_error_type()

Fetch a list of tasks.

fetch_unit(req, id)

@spec fetch_unit(req :: Req.Request.t(), id :: integer()) ::
  {:ok, %{id: integer(), name: String.t()}} | api_error_type()

Fetch a unit.

fetch_units(req, opts \\ [])

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

Fetch a list of units.

fetch_user(req, user_id)

@spec fetch_user(req :: Req.Request.t(), user_id :: non_neg_integer()) ::
  {:ok, BexioApiClient.Others.User.t()} | api_error_type()

Fetch a single user.

fetch_users(req)

@spec fetch_users(req :: Req.Request.t()) ::
  {:ok, [BexioApiClient.Others.User.t()]} | api_error_type()

Fetch a list of users.

get_access_information(req)

@spec get_access_information(req :: Req.Request.t()) ::
  {:ok, BexioApiClient.Others.Permission.t()} | api_error_type()

Get access information of logged in user

restriction(binary)

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

@spec search_countries(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Others.Country.t()]} | api_error_type()

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

  • name
  • name_short

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

@spec search_languages(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Others.Language.t()]} | api_error_type()

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

  • name
  • iso_639_1

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

@spec search_notes(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Others.Note.t()]} | api_error_type()

Search a note

Following fields are supported:

  • event_start
  • contact_id
  • user_id
  • subject
  • module_id
  • entry_id

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

@spec search_payment_types(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, map()} | api_error_type()

Search a payment type

Following fields are supported:

  • name

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

@spec search_tasks(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [Task.t()]} | api_error_type()

Search a task

Following fields are supported:

  • subject
  • updated_at
  • user_id
  • contact_id
  • todo_status_id
  • module_id
  • entry_id

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

@spec search_units(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, map()} | api_error_type()

Search a unit

Following fields are supported:

  • name

update_fictional_user(req, fictional_user)

@spec update_fictional_user(
  req :: Req.Request.t(),
  fictional_user :: BexioApiClient.Others.FictionalUser.t()
) :: {:ok, BexioApiClient.Others.FictionalUser.t()} | api_error_type()

Create a fictional user