BexioApiClient.Items (bexio_api_client v0.1.6)
Bexio API for the items & products part of the API
Link to this section Summary
Functions
Fetch single item.
Fetch a list of items.
Fetch a list of stock areas.
Fetch a list of stock locations.
Search items via query. The following search fields are supported
Search sock areas via query. The following search fields are supported
Search sock locations via query. The following search fields are supported
Link to this section Functions
Link to this function
fetch_item(client, id)
@spec fetch_item( client :: Tesla.Client.t(), id :: non_neg_integer() ) :: {:ok, [BexioApiClient.Items.Item.t()]} | {:error, any()}
Fetch single item.
Link to this function
fetch_items(client, opts \\ [])
@spec fetch_items( client :: Tesla.Client.t(), opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, [BexioApiClient.Items.Item.t()]} | {:error, any()}
Fetch a list of items.
Link to this function
fetch_stock_areas(client, opts \\ [])
@spec fetch_stock_areas( client :: Tesla.Client.t(), opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, [BexioApiClient.Items.Item.t()]} | {:error, any()}
Fetch a list of stock areas.
Link to this function
fetch_stock_locations(client, opts \\ [])
@spec fetch_stock_locations( client :: Tesla.Client.t(), opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, [BexioApiClient.Items.Item.t()]} | {:error, any()}
Fetch a list of stock locations.
Link to this function
search_items(client, criteria, opts \\ [])
@spec search_items( client :: Tesla.Client.t(), criteria :: [BexioApiClient.SearchCriteria.t()], opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, [BexioApiClient.Items.Item.t()]} | {:error, any()}
Search items via query. The following search fields are supported:
- intern_name
- intern_code
Link to this function
search_stock_areas(client, criteria, opts \\ [])
@spec search_stock_areas( client :: Tesla.Client.t(), criteria :: [BexioApiClient.SearchCriteria.t()], opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, [BexioApiClient.Items.Item.t()]} | {:error, any()}
Search sock areas via query. The following search fields are supported:
- name
- stock_id
Link to this function
search_stock_locations(client, criteria, opts \\ [])
@spec search_stock_locations( client :: Tesla.Client.t(), criteria :: [BexioApiClient.SearchCriteria.t()], opts :: [BexioApiClient.GlobalArguments.offset_arg()] ) :: {:ok, [BexioApiClient.Items.Item.t()]} | {:error, any()}
Search sock locations via query. The following search fields are supported:
- name