translator_directory.models.time_report
=======================================

.. py:module:: translator_directory.models.time_report


Attributes
----------

.. autoapisummary::

   translator_directory.models.time_report.TimeReportStatus


Classes
-------

.. autoapisummary::

   translator_directory.models.time_report.TranslatorTimeReport


Module Contents
---------------

.. py:data:: TimeReportStatus

.. py:class:: TranslatorTimeReport

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   Mixin providing created/modified timestamps for all records.

   The columns are deferred loaded as this is primarily for logging and future
   forensics.



   .. py:attribute:: __tablename__
      :value: 'translator_time_reports'



   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: translator_id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: translator
      :type:  sqlalchemy.orm.relationship[translator_directory.models.translator.Translator]


   .. py:attribute:: created_by_id
      :type:  sqlalchemy.Column[uuid.UUID | None]


   .. py:attribute:: created_by
      :type:  sqlalchemy.orm.relationship[onegov.user.User | None]


   .. py:attribute:: assignment_type
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: duration
      :type:  sqlalchemy.Column[int]


   .. py:attribute:: case_number
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: assignment_date
      :type:  sqlalchemy.Column[datetime.date]


   .. py:attribute:: hourly_rate
      :type:  sqlalchemy.Column[decimal.Decimal]


   .. py:attribute:: surcharge_percentage
      :type:  sqlalchemy.Column[decimal.Decimal]


   .. py:attribute:: travel_compensation
      :type:  sqlalchemy.Column[decimal.Decimal]


   .. py:attribute:: total_compensation
      :type:  sqlalchemy.Column[decimal.Decimal]


   .. py:attribute:: notes
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: status
      :type:  sqlalchemy.Column[TimeReportStatus]


   .. py:property:: duration_hours
      :type: decimal.Decimal


      Return duration in hours for display.



   .. py:property:: base_compensation
      :type: decimal.Decimal


      Calculate compensation without travel.



   .. py:property:: meal_allowance
      :type: decimal.Decimal


      Return meal allowance if duration >= 6 hours.



   .. py:property:: title
      :type: str


      Return a readable title for this time report.