Settlement Report
=================

.. glossary::

    Settlement Report

        The Settlement Report shows details with fund subtotals for a batch. The report can be used as an aid
        in reconciliation and in general ledger entry. It includes a column for the fund's Income Account
        (labeled as **Ledger**).

        This Python script will create a report for a single settlement batch from your payment gateway. The report
        can be accessed from the :term:`Reconcile Report` by clicking on the **Total** for the desired batch.
        The Settlement Report will present a header with the Batch Reference ID and the Batch Type (e.g., **eft** or
        **bankcard**) followed by the date and time the settlement batch was completed by the payment gateway.

        Below the header will be the details of the batch with subtotals for each included fund. Registration
        payments will be in their own section with a subtotal. (For general ledger entry of registration
        payments, we recommend either the :term:`Totals by Description` or the :term:`Totals by Batch/Description`
        report.)

        Some of the information shown on the report acts as links to further information. Links can be recognized
        by the blue color and the underlining.

        *   **Name** links will open a new tab with that person's profile.
        *   **Date** links will open a new tab with the online transaction for that entry.
        *   **Amount** links will open a new tab with the TouchPoint batch containing that contribution entry.

        .. figure:: https://i.tpsdb.com/BatchReportLink.png
            :target: #

            Settlement Report Link in Reconcile Report

        .. figure:: https://i.tpsdb.com/BatchReport.png
            :target: #

            Settlement Report

Configure the Settlement Report
-------------------------------
The standard form of the Settlement Report is already loaded on your database. The administration setting
**CustomBatchReport**, found under the Finance tab and in the Contribution Search section, points the
system to the report. The value of this setting should be the URL to the Settlement Report,
`/PyScript/BatchReport?p1={batchref}`. Or, if you have created an alternate settlement report, you can
substitute into the setting the name of your settlement report (in place of `BatchReport`).

Run the Settlement Report
-------------------------

The link will display (as you see in the image above) in the **Total** column of the Reconcile Report. Click the
link to display the report for that batch. The report will include information about online transactions with
that batch reference.

If desired, you can use the print feature of your browser to print the report.

.. _BatchReportCode:

Code for the Settlement Report Python Script
--------------------------------------------

.. literalinclude:: Files/SettlementReport.py
    :linenos:

|
|

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

Updated name of the report to **Settlement Report**