BexioApiClient.Accounting.ManualEntry (bexio_api_client v2.0.0)

Bexio Manual Entry Module.

A manual entry (booking) in the account ledger, consisting of one or multiple BexioApiClient.Accounting.ManualEntryLines.

Summary

Types

t()

Bexio Manual Entry

Functions

new(attrs \\ %{})

Create a new manual entry (for create_manual_entry/2 or edit_manual_entry/2). The id, the user ids and the lock state are ignored when creating.

Types

t()

@type t() :: %BexioApiClient.Accounting.ManualEntry{
  created_by_user_id: integer() | nil,
  date: Date.t(),
  edited_by_user_id: integer() | nil,
  entries: [BexioApiClient.Accounting.ManualEntryLine.t()],
  id: integer() | nil,
  locked?: boolean(),
  locked_info: String.t() | nil,
  reference_nr: String.t() | nil,
  type: :manual_single_entry | :manual_compound_entry | :manual_group_entry
}

Bexio Manual Entry

Fields:

:id - automatic id given by bexio (nil for a not yet created entry)
:type - either :manual_single_entry, :manual_compound_entry or :manual_group_entry
:date - the booking date
:reference_nr - a reference number for the booking
:created_by_user_id - the id of the user who created the entry
:edited_by_user_id - the id of the user who last edited the entry
:entries - the single booking lines of the entry
:locked? - whether the manual entry is locked (e.g. in a closed business year)
:locked_info - the reason why the manual entry is locked

Functions

new(attrs \\ %{})

@spec new(map()) :: t()

Create a new manual entry (for create_manual_entry/2 or edit_manual_entry/2). The id, the user ids and the lock state are ignored when creating.