BexioApiClient.Contacts.Contact (bexio_api_client v2.0.0)

Copy Markdown

Bexio Contact Module.

Summary

Types

t()

Bexio Contact (company or person).

Functions

Create a new contact

Types

t()

@type t() :: %BexioApiClient.Contacts.Contact{
  address: String.t(),
  address_addition: String.t() | nil,
  birthday: Date.t(),
  city: String.t(),
  contact_branch_ids: [integer()],
  contact_group_ids: [integer()],
  contact_type: :company | :person,
  country_id: integer(),
  fax: String.t(),
  house_number: String.t() | nil,
  id: integer(),
  language_id: integer(),
  lead?: boolean(),
  mail: String.t(),
  mail_second: String.t(),
  name_1: String.t(),
  name_2: String.t(),
  nr: integer() | nil,
  owner_id: integer(),
  phone_fixed: String.t(),
  phone_fixed_second: String.t(),
  phone_mobile: String.t(),
  postcode: String.t(),
  profile_image: String.t() | nil,
  remarks: String.t(),
  salutation_form: integer(),
  salutation_id: integer(),
  skype_name: String.t(),
  street_name: String.t() | nil,
  title_id: integer(),
  updated_at: NaiveDateTime.t(),
  url: String.t(),
  user_id: integer()
}

Bexio Contact (company or person).

Fields:

  • :id - automatic id given by bexio
  • :nr - must be a number, can also be used as integer; nil when assigned automatically
  • :contact_type - either :company or :person
  • :name_1 - for :company the company name and for :person the last name
  • :name_2 - for :company the company addition and for :person the first name
  • :salutation_id- reference to a TODO: salutation object
  • :salutation_form - ??
  • :title_id - reference to a TODO: title object
  • :birthday - birthday (:person) or foundation date (:company)
  • :address - street and additional address information
  • :street_name - street name (the :address field is deprecated by bexio in favor of the structured address fields)
  • :house_number - house number
  • :address_addition - additional address information
  • :postcode - postal code / zip
  • :city - city
  • :country_id - reference to a TODO: country object
  • :mail - email address
  • :mail_second - secondary email address
  • :phone_fixed - phone number (fixed)
  • :phone_fixed_secondary - secondary phone number (fixed)
  • :phone_mobile - phone number (mobile)
  • :fax - number for this old fax devices out there
  • :url - homepage url
  • :skype_name - Skype Name
  • :remarks - free text for remarks
  • :lead? - whether the contact is a lead
  • :language_id - reference to a TODO: language object
  • :contact_group_ids - reference to multiple TODO: contact group objects
  • :contact_branch_ids - reference to multiple TODO: contact sector objects
  • :user_id - creator of the record, reference to a TODO: user object
  • :owner_id - owner of the record, reference to a TODO: user object
  • :updated_at - date time of the last update (zurich time zone)
  • :profile_image - base64 encoded profile image (only part of the show-contact response)

Functions

new(attrs \\ %{})

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

Create a new contact