BexioApiClient.BusinessActivities (bexio_api_client v2.0.0)

Bexio API for the business activities, communication types and client services part of the API.

The business activities (client service) endpoints implement the operations the bexio docs group under "Business Activities" (/2.0/client_service, operationIds v2ListBusinessActivities, v2CreateBusinessActivity, v2SearchBusinessActivities).

Summary

Types

api_error_type()

Functions

create_business_activity(req, business_activity)

Create a business activity (client service).

fetch_business_activities(req, opts \\ [])

Fetch a list of business activities (client services).

fetch_communication_types(req, opts \\ [])

Fetch a list of communication types.

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

Search business activities (client services) via query.

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

Search communication types via query.

Types

api_error_type()

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

Functions

create_business_activity(req, business_activity)

@spec create_business_activity(
  req :: Req.Request.t(),
  business_activity :: BexioApiClient.BusinessActivities.BusinessActivity.t()
) ::
  {:ok, BexioApiClient.BusinessActivities.BusinessActivity.t()}
  | api_error_type()

Create a business activity (client service).

fetch_business_activities(req, opts \\ [])

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

Fetch a list of business activities (client services).

fetch_communication_types(req, opts \\ [])

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

Fetch a list of communication types.

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

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

Search business activities (client services) via query.

Following fields are supported:

name

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

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

Search communication types via query.

Following fields are supported:

name