BexioApiClient.Projects.Project (bexio_api_client v2.0.0)

Copy Markdown

Bexio Project Module.

Summary

Types

t()

Bexio Project

Functions

Create a new project

Types

t()

@type t() :: %BexioApiClient.Projects.Project{
  comment: String.t() | nil,
  contact_id: integer() | nil,
  contact_sub_id: integer() | nil,
  document_nr: String.t() | nil,
  end_date: NaiveDateTime.t() | nil,
  id: integer() | nil,
  name: String.t() | nil,
  nr: String.t() | nil,
  pr_budget_type:
    :total_budget_costs
    | :total_budget_hours
    | :budget_per_client_service
    | :budget_per_employee
    | integer()
    | nil,
  pr_budget_type_amount: Decimal.t() | nil,
  pr_invoice_type:
    :hourly_rate_client_services
    | :hourly_rate_employee
    | :hourly_rate_project
    | :fix_price_project
    | integer()
    | nil,
  pr_invoice_type_amount: Decimal.t() | nil,
  pr_project_type_id: integer() | nil,
  pr_state_id: integer() | nil,
  start_date: NaiveDateTime.t() | nil,
  user_id: integer() | nil,
  uuid: String.t() | nil
}

Bexio Project

Fields:

  • :id - automatic id given by bexio
  • :document_nr - can not be used if "automatic numbering" is activated in the frontend settings, required if it is deactivated (only used for create/edit)
  • :uuid - the uuid of the project
  • :nr - the project number
  • :name - the name of the project
  • :start_date - the start date of the project
  • :end_date - the end date of the project
  • :comment - a comment
  • :pr_state_id - references a project status object
  • :pr_project_type_id - references a project type object
  • :contact_id - references a contact object
  • :contact_sub_id - references a contact object
  • :pr_invoice_type - :hourly_rate_client_services (bexio's 1), :hourly_rate_employee (2), :hourly_rate_project (3) or :fix_price_project (4)
  • :pr_invoice_type_amount - only editable if :pr_invoice_type is set and only supported for invoice types :hourly_rate_project and :fix_price_project
  • :pr_budget_type - :total_budget_costs (bexio's 1), :total_budget_hours (2), :budget_per_client_service (3) or :budget_per_employee (4)
  • :pr_budget_type_amount - only editable if :pr_budget_type is set and only supported for budget types :total_budget_costs and :total_budget_hours
  • :user_id - references a user object

Functions

new(attrs \\ %{})

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

Create a new project