BexioApiClient.Payroll.Employee (bexio_api_client v2.0.0)

Copy Markdown

Payroll Employee.

Summary

Types

t()

Payroll Employee.

Functions

Builds a new employee for creating or updating via the API.

Types

t()

@type t() :: %BexioApiClient.Payroll.Employee{
  address: BexioApiClient.Payroll.Address.t() | nil,
  ahv_number: String.t() | nil,
  annual_vacation_days: integer() | nil,
  annual_vacation_days_left: number() | nil,
  annual_vacation_days_total: number() | nil,
  annual_vacation_days_used: number() | nil,
  date_of_birth: Date.t() | nil,
  effective_working_hours_per_week: number() | nil,
  email: String.t() | nil,
  employment_level: number() | nil,
  first_name: String.t(),
  gender: :male | :female | nil,
  hours_per_week: number() | nil,
  iban: String.t() | nil,
  id: String.t(),
  language: :de | :it | :fr | :en | nil,
  last_name: String.t(),
  marital_status:
    :unknown
    | :single
    | :married
    | :separated
    | :registered_partnership
    | :partnership_dissolved_by_law
    | :partnership_dissolved_by_death
    | :partnership_dissolved_by_declaration_of_lost
    | :widowed
    | :divorced
    | nil,
  nationality: String.t() | nil,
  personal_number: String.t() | nil,
  phone_number: String.t() | nil,
  stay_permit_category: String.t() | nil
}

Payroll Employee.

Fields:

  • :annual_vacation_days_used - not part of the list response, only of the single/create response
  • :annual_vacation_days_left - not part of the list response, only of the single/create response
  • :effective_working_hours_per_week - not part of the list response, only of the single/create response
  • :annual_vacation_days - only used in create/update requests, the responses contain :annual_vacation_days_total instead

Functions

new(attrs \\ %{})

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

Builds a new employee for creating or updating via the API.