.. index:: Core Operations; Occurrence Franchise Deductible
.. _core-operation-franchise-deductible:

OccurrenceFranchiseDeductible
==================================

Applies a franchise deductible to the sum of a group of records that share
equal values for their ``Trial``, ``Time``, and ``OccurrenceKey`` attributes. Once the
franchise deductible is applied, the result is applied to all records in the
group.

Structure
---------

.. code-block:: json

    {
        "_schema": "OccurrenceFranchiseDeductible_1.0",
        "franchise_deductible": 1000,
        "currency": "GBP"
    }

Parameters
----------

+---------------------------+----------+------------------+-----------------------------------------------------------------------------+
| Parameter Name            | Required | Type             | Description                                                                 |
+===========================+==========+==================+=============================================================================+
| ``franchise_deductible``  | Yes      | ``double``       | The franchise deductible value in currency units. Cannot be negative.       |
+---------------------------+----------+------------------+-----------------------------------------------------------------------------+
| ``currency``              | No       | ``string``       | The currency in which ``franchise_deductible`` is defined.                  |
+---------------------------+----------+------------------+-----------------------------------------------------------------------------+

Behaviour
--------------

This applies on groups of records with the same ``Trial``, ``Time`` and
``OccurrenceKey`` attributes. If the sum of the ``Value`` fields of all records within
the grouping is less than ``-1 * adjusted_value``, then it emits the
records within the grouping without modification.
If the sum of ``Value`` fields is greater than or equal to ``-1 * adjusted_value``,
or the sum of records is equal to 0, then it emits the records
within the grouping with all of their ``Value`` fields set to 0.