bexio_api_client
v0.6.4

BexioApiClient.Items (bexio_api_client v0.6.4)

Bexio API for the items & products part of the API

Link to this section Summary

Types

api_error_type()

Functions

create_item(req, item)

Create an item.

delete_item(req, id)

Delete an order.

edit_item(req, item)

Edit an item.

fetch_item(req, id)

Fetch single item.

fetch_items(req, opts \\ [])

Fetch a list of items.

fetch_stock_areas(req, opts \\ [])

Fetch a list of stock areas.

fetch_stock_locations(req, opts \\ [])

Fetch a list of stock locations.

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

Search items via query. The following search fields are supported

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

Search sock areas via query. The following search fields are supported

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

Search sock locations 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

create_item(req, item)

@spec create_item(
  req :: Req.Request.t(),
  item :: BexioApiClient.Items.Item.t()
) :: {:ok, BexioApiClient.Items.Item.t()} | api_error_type()

Create an item.

Link to this function

delete_item(req, id)

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

Delete an order.

Link to this function

edit_item(req, item)

@spec edit_item(
  req :: Req.Request.t(),
  item :: BexioApiClient.Items.Item.t()
) :: {:ok, BexioApiClient.Items.Item.t()} | api_error_type()

Edit an item.

Link to this function

fetch_item(req, id)

@spec fetch_item(
  req :: Req.Request.t(),
  id :: non_neg_integer()
) :: {:ok, BexioApiClient.Items.Item.t()} | api_error_type()

Fetch single item.

Link to this function

fetch_items(req, opts \\ [])

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

Fetch a list of items.

Link to this function

fetch_stock_areas(req, opts \\ [])

@spec fetch_stock_areas(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Fetch a list of stock areas.

Link to this function

fetch_stock_locations(req, opts \\ [])

@spec fetch_stock_locations(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Fetch a list of stock locations.

Link to this function

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

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

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

  • intern_name
  • intern_code
Link to this function

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

@spec search_stock_areas(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Search sock areas via query. The following search fields are supported:

  • name
  • stock_id
Link to this function

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

@spec search_stock_locations(
  req :: Req.Request.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, %{required(integer()) => String.t()}} | api_error_type()

Search sock locations via query. The following search fields are supported:

  • name