activity.iso20022
=================

.. py:module:: activity.iso20022


Attributes
----------

.. autoapisummary::

   activity.iso20022.DOCUMENT_NS_EX


Classes
-------

.. autoapisummary::

   activity.iso20022.Transaction


Functions
---------

.. autoapisummary::

   activity.iso20022.normalize_xml
   activity.iso20022.transaction_entries
   activity.iso20022.get_esr
   activity.iso20022.extract_transactions
   activity.iso20022.match_iso_20022_to_usernames


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

.. py:data:: DOCUMENT_NS_EX

.. py:function:: normalize_xml(xml: str) -> str

.. py:class:: Transaction(**kwargs: object)

   .. py:attribute:: username
      :value: ''



   .. py:attribute:: confidence
      :value: 0.0



   .. py:attribute:: duplicate
      :value: False



   .. py:attribute:: paid
      :value: False



   .. py:method:: __repr__() -> str


   .. py:method:: __getattr__(name: str) -> Any


   .. py:property:: references
      :type: set[str]



   .. py:method:: extract_references() -> collections.abc.Iterator[str]


   .. py:property:: order
      :type: tuple[int, int] | tuple[int, int, str]



   .. py:property:: state
      :type: str



.. py:function:: transaction_entries(root: lxml.etree._Element) -> collections.abc.Iterator[lxml.etree._Element]

   Yields the transaction entries from the given Camt.053 or Camt.054
   xml. This works because for our purposes the entries of those two formats
   are identical.



.. py:function:: get_esr(booking_text: str) -> str | None

   Extracts the QR-bill reference number from the given text.
   QR-bill reference numbers are usually 26 or 27 characters long but can
   be of any length.
   The 27-character version includes a check digit at the
   end. The 26-character version doesn't include the check digit.
   For any other length we don't know if the check digit is included or not.

   For example:

   input: 'Gutschrift QRR: 27 99029 05678 18860 27295 37059'
   output: '269902905678188602729537059'

   :returns: The extracted reference number or None if no reference number.
   If the extracted reference number is only 26 characters long, the check
   digit is appended to the end.


.. py:function:: extract_transactions(xml: str, invoice_schema: str) -> collections.abc.Iterator[Transaction]

.. py:function:: match_iso_20022_to_usernames(xml: str, session: sqlalchemy.orm.Session, period_id: uuid.UUID, schema: str, currency: str = 'CHF') -> collections.abc.Iterator[Transaction]

   Takes an ISO20022 camt.053 file and matches it with the invoice
   items in the database.

   Raises an error if the given xml cannot be processed.

   :return: An iterator of transactions found in the xml file, together with
       the matching username and a confidence attribute indicating how
       certain the match is (1.0 indicating a sure match, 0.5 a possible match
       and 0.0 a non-match).