BexioApiClient.SalesOrderManagement.Quote (bexio_api_client v0.7.0)

Quote

Link to this section Summary

Types

t()

Quote

Functions

Create a new quote

Link to this section Types

@type t() :: %BexioApiClient.SalesOrderManagement.Quote{
  api_reference: String.t() | nil,
  bank_account_id: integer(),
  contact_address: String.t(),
  contact_id: integer() | nil,
  contact_sub_id: integer() | nil,
  currency_id: integer(),
  delivery_address: String.t(),
  delivery_address_type: integer(),
  document_nr: String.t(),
  footer: String.t(),
  header: String.t(),
  id: integer(),
  is_valid_from: Date.t(),
  is_valid_until: Date.t(),
  kb_item_status: :draft | :pending | :confirmed | :declined,
  kb_terms_of_payment_template_id: integer() | nil,
  language_id: integer(),
  mwst_is_net?: boolean(),
  mwst_type: :including | :excluding | :exempt,
  network_link: String.t() | nil,
  payment_type_id: integer(),
  positions:
    [
      BexioApiClient.SalesOrderManagement.PositionDefault.t()
      | BexioApiClient.SalesOrderManagement.PositionDiscount.t()
      | BexioApiClient.SalesOrderManagement.PositionItem.t()
      | BexioApiClient.SalesOrderManagement.PositionPagebreak.t()
      | BexioApiClient.SalesOrderManagement.PositionSubposition.t()
      | BexioApiClient.SalesOrderManagement.PositionSubtotal.t()
      | BexioApiClient.SalesOrderManagement.PositionText.t()
    ]
    | nil,
  project_id: integer() | nil,
  show_position_taxes?: boolean(),
  show_total?: boolean(),
  taxs: [%{percentage: Decimal.t(), value: Decimal.t()}],
  template_slug: String.t() | nil,
  title: String.t() | nil,
  total: Decimal.t(),
  total_gross: Decimal.t(),
  total_net: Decimal.t(),
  total_rounding_difference: float(),
  total_taxes: Decimal.t(),
  updated_at: NaiveDateTime.t(),
  user_id: integer(),
  viewed_by_client_at: NaiveDateTime.t() | nil
}

Quote

fields

Fields:

  • :contact_id - references a contact object
  • :contact_sub_id - references a contact object
  • :user_id - references a user object
  • :project_id - references a project object
  • :language_id - references a language object
  • :bank_account_id - references a bank account object
  • :currency_id - references a currency object
  • :payment_type_id - references a payment type object
  • :mwst_is_net? - this value affects the total if the field mwst_type has been set to :include. false - taxes are included in the total, true - taxes will be added to total
  • :kb_item_status is converted from kb_item_status_id rest field
  • :api_reference - this field can only be read and edited by the api. it can be used to save references to other systems
  • :template_slug - references a document template slug
  • :taxs - map of percentage as key and absolute values as value
  • :network_link - the network link of the quote

Link to this section Functions

Link to this function

new(attrs \\ %{})

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

Create a new quote