BexioApiClient.Contacts (bexio_api_client v0.1.4)
Bexio API for the contacts part of the API.
Link to this section Summary
Functions
Fetch a list of contacts.
Link to this section Functions
Link to this function
fetch_contacts(client, order_by \\ nil, limit \\ nil, offset \\ nil, show_archived \\ nil)
@spec fetch_contacts( client :: Tesla.Client.t(), order_by :: :id | :nr | :name_1 | :updated_at | :id_desc | :nr_desc | :offset_desc | :updated_at_desc | :id_asc | :nr_asc | :offset_asc | :updated_at_asc | nil, limit :: pos_integer() | nil, offset :: non_neg_integer() | nil, show_archived :: boolean() | nil ) :: {:ok, [BexioApiClient.Contacts.Contact.t()]} | {:error, any()}
Fetch a list of contacts.
arguments
Arguments:
:client
- client to execute the HTTP request with:order_by
- field for ordering the records, appending_asc
or_desc
defines whether it's ascending (default) or descending:limit
- limit the number of results (default: 500, max: 2000):offset
- Skip over a number of elements by specifying an offset value for the query:show_archived
- Show archived elements only