Batch Report
============
.. include:: BatchSummary.rst

.. note::
    When configured, the report can be run by clicking the report icon for the desired batch.
    See :ref:`image below <BatchReportLink>`.


.. glossary::

    Batch Report

        This report provides the following information for each batch.
       
        Header
            -  Church Name
            -  Batch ID
            -  Batch Type
            -  Collected date (Contribution Date for batch)
            -  Created date
            -  Printed date (current date)
            -  Deposited date
            -  totals for Cash and for Checks

        Details
            -  Contributor Name
            -  Type (Cash or Check)
            -  Amount
            -  Fund
            -  Check Number

        In the details, cash donations are listed first with a sub-total, followed by check 
        donations with a sub-total, then a grand total for the batch.

        There is also a signature line, so you can print this report and have your counters 
        sign off on it.

.. _BatchReportLink:

.. figure:: https://i.tpsdb.com/2023-06-22_16-05-02.png
    :target: #

    Report Icon

.. figure:: https://i.tpsdb.com/./2018-02-05_08-26-35.png
    :target: #

    Sample Report

Create the Batch Report
-----------------------

Step 1
    Go to `Administration > Setup > Special Content > Python Scripts`.

Step 2
    Click the green `+ New Python Script File`, enter the file name ``BatchReport``
    and click `Submit`.

Step 3
    :ref:`Copy all the Python code below<BatchReport2Code>` and paste it into the new file.

    Click `Save Script`.

Step 4
    -  Find the Setting ``Custom Batch Report`` at `Administration > Setup > Settings` on the Finance tab and in the Batches category
    -  Paste this as the value - ``/PyScript/BatchReport?p1={bundleid}``

.. note::
    Each database can have only one Batch Report. So, the Setting is just named
    **CustomBatchReport** and the Value determines which is used.

Generate the Batch Report
-------------------------
To generate the report, click the report icon for the desired batch.

Use the print feature of your browser to print the report. 


Python Code
-----------

.. _BatchReport2Code:

.. literalinclude:: Files/BatchReport.py
    :linenos:


|
|

+--------------------+------------------+
| **Latest Update**  | **10/06/2023**   |
+--------------------+------------------+

Update links to related articles