BexioApiClient.SalesOrderManagement (bexio_api_client v0.1.6)

Bexio API for the sales order management part of the API.

Link to this section Summary

Functions

This action fetches a list of comments.

This action fetches a single default position for a document.

This action fetches a list of all default positions for a document.

This action fetches a single discount position for a document.

This action fetches a list of all discount positions for a document.

This action fetches a single item position for a document.

This action fetches a list of all item positions for a document.

This action fetches a single order

This action fetches a list of all orders.

This action fetches a single pagebreak position for a document.

This action fetches a list of all pagebreak positions for a document.

This action fetches a single quote

This action fetches a list of all quotes.

This action fetches a single subposition position for a document.

This action fetches a list of all subposition positions for a document.

This action fetches a single subtotal position for a document.

This action fetches a list of all subtotal positions for a document.

This action fetches a single text position for a document.

This action fetches a list of all text positions for a document.

Search orders via query. The following search fields are supported

Search quotes via query. The following search fields are supported

Link to this section Functions

Link to this function

create_comment(client, document_type, document_id, comment)

@spec create_comment(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  comment :: BexioApiClient.SalesOrderManagement.Comment.t()
) :: {:ok, [BexioApiClient.SalesOrderManagement.Comment.t()]} | {:error, any()}

Create a comment

Link to this function

fetch_comment(client, document_type, document_id, comment_id)

@spec fetch_comment(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  comment_id :: pos_integer()
) :: {:ok, [BexioApiClient.SalesOrderManagement.Comment.t()]} | {:error, any()}

This action fetches a single comment.

Link to this function

fetch_comments(client, document_type, document_id, opts \\ [])

@spec fetch_comments(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) :: {:ok, [BexioApiClient.SalesOrderManagement.Comment.t()]} | {:error, any()}

This action fetches a list of comments.

Link to this function

fetch_default_position(client, document_type, document_id, position_id)

@spec fetch_default_position(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  position_id :: pos_integer()
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionDefault.t()]}
  | {:error, any()}

This action fetches a single default position for a document.

Link to this function

fetch_default_positions(client, document_type, document_id, opts \\ [])

@spec fetch_default_positions(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionDefault.t()]}
  | {:error, any()}

This action fetches a list of all default positions for a document.

Link to this function

fetch_discount_position(client, document_type, document_id, position_id)

@spec fetch_discount_position(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  position_id :: pos_integer()
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionDiscount.t()]}
  | {:error, any()}

This action fetches a single discount position for a document.

Link to this function

fetch_discount_positions(client, document_type, document_id, opts \\ [])

@spec fetch_discount_positions(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionDiscount.t()]}
  | {:error, any()}

This action fetches a list of all discount positions for a document.

Link to this function

fetch_item_position(client, document_type, document_id, position_id)

@spec fetch_item_position(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  position_id :: pos_integer()
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionItem.t()]}
  | {:error, any()}

This action fetches a single item position for a document.

Link to this function

fetch_item_positions(client, document_type, document_id, opts \\ [])

@spec fetch_item_positions(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionItem.t()]}
  | {:error, any()}

This action fetches a list of all item positions for a document.

Link to this function

fetch_order(client, order_id)

@spec fetch_order(
  client :: Tesla.Client.t(),
  order_id :: pos_integer()
) :: {:ok, [BexioApiClient.SalesOrderManagement.Order.t()]} | {:error, any()}

This action fetches a single order

Link to this function

fetch_orders(client, opts \\ [])

@spec fetch_orders(
  client :: Tesla.Client.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.SalesOrderManagement.Order.t()]} | {:error, any()}

This action fetches a list of all orders.

Link to this function

fetch_pagebreak_position(client, document_type, document_id, position_id)

@spec fetch_pagebreak_position(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  position_id :: pos_integer()
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionPagebreak.t()]}
  | {:error, any()}

This action fetches a single pagebreak position for a document.

Link to this function

fetch_pagebreak_positions(client, document_type, document_id, opts \\ [])

@spec fetch_pagebreak_positions(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionPagebreak.t()]}
  | {:error, any()}

This action fetches a list of all pagebreak positions for a document.

Link to this function

fetch_quote(client, quote_id)

@spec fetch_quote(
  client :: Tesla.Client.t(),
  quote_id :: pos_integer()
) :: {:ok, [BexioApiClient.SalesOrderManagement.Quote.t()]} | {:error, any()}

This action fetches a single quote

Link to this function

fetch_quotes(client, opts \\ [])

@spec fetch_quotes(
  client :: Tesla.Client.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.SalesOrderManagement.Quote.t()]} | {:error, any()}

This action fetches a list of all quotes.

Link to this function

fetch_subposition_position(client, document_type, document_id, position_id)

@spec fetch_subposition_position(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  position_id :: pos_integer()
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionSubposition.t()]}
  | {:error, any()}

This action fetches a single subposition position for a document.

Link to this function

fetch_subposition_positions(client, document_type, document_id, opts \\ [])

@spec fetch_subposition_positions(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionSubposition.t()]}
  | {:error, any()}

This action fetches a list of all subposition positions for a document.

Link to this function

fetch_subtotal_position(client, document_type, document_id, position_id)

@spec fetch_subtotal_position(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  position_id :: pos_integer()
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionSubtotal.t()]}
  | {:error, any()}

This action fetches a single subtotal position for a document.

Link to this function

fetch_subtotal_positions(client, document_type, document_id, opts \\ [])

@spec fetch_subtotal_positions(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionSubtotal.t()]}
  | {:error, any()}

This action fetches a list of all subtotal positions for a document.

Link to this function

fetch_text_position(client, document_type, document_id, position_id)

@spec fetch_text_position(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  position_id :: pos_integer()
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionText.t()]}
  | {:error, any()}

This action fetches a single text position for a document.

Link to this function

fetch_text_positions(client, document_type, document_id, opts \\ [])

@spec fetch_text_positions(
  client :: Tesla.Client.t(),
  document_type :: :offer | :order | :invoice,
  document_id :: pos_integer(),
  opts :: [BexioApiClient.GlobalArguments.offset_without_order_by_arg()]
) ::
  {:ok, [BexioApiClient.SalesOrderManagement.PositionText.t()]}
  | {:error, any()}

This action fetches a list of all text positions for a document.

Link to this function

search_orders(client, criteria, opts \\ [])

@spec search_orders(
  client :: Tesla.Client.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.SalesOrderManagement.Order.t()]} | {:error, any()}

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

  • id
  • kb_item_status
  • document_nr
  • title
  • contact_id
  • contact_sub_id
  • user_id
  • currency_id
  • total_gross
  • total_net
  • total
  • is_valid_from
  • updated_at
Link to this function

search_quotes(client, criteria, opts \\ [])

@spec search_quotes(
  client :: Tesla.Client.t(),
  criteria :: [BexioApiClient.SearchCriteria.t()],
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.SalesOrderManagement.Quote.t()]} | {:error, any()}

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

  • id
  • kb_item_status
  • document_nr
  • title
  • contact_id
  • contact_sub_id
  • user_id
  • currency_id
  • total_gross
  • total_net
  • total
  • is_valid_from
  • is_valid_until
  • is_valid_to (?)
  • updated_at