BexioApiClient.Timesheets (bexio_api_client v2.0.0)

Copy Markdown

Bexio API for the timesheets part of the API

Summary

Functions

Create a timesheet.

Delete a timesheet.

Edit a timesheet.

Fetch a single timesheet.

Fetch a list of timesheet statuses.

Fetch a list of timesheets.

Search timesheets via query. The following search fields are supported

Types

api_error_type()

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

Functions

create_timesheet(req, timesheet)

@spec create_timesheet(
  req :: Req.Request.t(),
  timesheet :: BexioApiClient.Timesheets.Timesheet.t()
) ::
  {:ok, BexioApiClient.Timesheets.Timesheet.t()} | api_error_type()

Create a timesheet.

delete_timesheet(req, id)

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

Delete a timesheet.

edit_timesheet(req, timesheet)

@spec edit_timesheet(
  req :: Req.Request.t(),
  timesheet :: BexioApiClient.Timesheets.Timesheet.t()
) ::
  {:ok, BexioApiClient.Timesheets.Timesheet.t()} | api_error_type()

Edit a timesheet.

fetch_timesheet(req, id)

@spec fetch_timesheet(req :: Req.Request.t(), id :: non_neg_integer()) ::
  {:ok, BexioApiClient.Timesheets.Timesheet.t()} | api_error_type()

Fetch a single timesheet.

fetch_timesheet_statuses(req, opts \\ [])

@spec fetch_timesheet_statuses(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) :: {:ok, [BexioApiClient.Timesheets.TimesheetStatus.t()]} | api_error_type()

Fetch a list of timesheet statuses.

fetch_timesheets(req, opts \\ [])

@spec fetch_timesheets(
  req :: Req.Request.t(),
  opts :: [BexioApiClient.GlobalArguments.offset_arg()]
) ::
  {:ok, [BexioApiClient.Timesheets.Timesheet.t()]} | api_error_type()

Fetch a list of timesheets.

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

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

  • id
  • client_service_id
  • contact_id
  • user_id
  • pr_project_id
  • status_id