.. include:: /Includes.rst.txt

.. _user-manual:

===========
User manual
===========

.. _user-manual-console:

Console
=======

.. code-block:: shell
   :caption: Get help

   path/to/bin/typo3 wise:getcredits -h

.. code-block:: shell
   :caption: Get credit transactions for all sites and all profile id's. The from time is derived from the last transaction record. In case no record is available the from time is one month back from now.

   path/to/bin/typo3 wise:getcredits

.. code-block:: shell
   :caption: Get credit transactions only for the site with identifier "default"

   path/to/bin/typo3 wise:getcredits -s default

.. code-block:: shell
   :caption: Get credit transactions only for the profile id 1234567

   path/to/bin/typo3 wise:getcredits -p 1234567

.. code-block:: shell
   :caption: Get credit transactions for the period 06.05.2022 - now

   path/to/bin/typo3 wise:getcredits -f 06.05.2022

.. code-block:: shell
   :caption: Get credit transactions until 06.06.2022

   path/to/bin/typo3 wise:getcredits -t 06.06.2022

.. code-block:: shell
   :caption: Get credit transactions for the period 06.05.2022 - 10.05.2022

   path/to/bin/typo3 wise:getcredits -f 06.05.2022 -t 10.05.2022

.. note::

   The php function `strtotime` is used to get the timestamp from a date.

.. note::

   The profile id is looked up on registered events. In case there are no event
   records it needs to be provided with the `-p` option.