.. _module-utility-credential-app-v0-model-accounting-24297:

Utility.Credential.App.V0.Model.Accounting
==========================================

Templates used for accounting of rewards earned\.

Templates
---------

.. _type-utility-credential-app-v0-model-accounting-feerecord-87321:

**template** `FeeRecord <type-utility-credential-app-v0-model-accounting-feerecord-87321_>`_

  A fee record that contains information on the CC fees burned as part of an app transfer\.

  Signatory\: operator, provider

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - operator
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - App operator\.
     * - provider
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Provider of the payment (e\.g\. a Credential issuer that bills a holder)\.
     * - user
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - App user that will receive a reward share (e\.g\. a Credential holder)\.
     * - dso
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - DSO (Decentralized Synchronizer Operations) party\.
     * - ccFeesBurned
       - `Decimal <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135>`_
       - CC fees burned in a single billing cycle\.
     * - extraFeaturedAppCcFeesBurned
       - `Decimal <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135>`_
       - For featured app providers, there is an additional amount added to the actual fee for reward calculation purposes\. This is determined in the ``AmuletRules``\.
     * - isFeatured
       - `Bool <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-bool-66265>`_
       - Whether the provider is a featured party at the time this record is created\.
     * - round
       - `Round <https://global.canton.network.digitalasset.com/app_dev/api/splice-amulet/Splice-Types.html#type-splice-types-round-16181>`_
       - Round used for billing\.
     * - reference
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Identifier that this billing refers to (e\.g\. a Credential identifier)

  + **Choice** Archive

    Controller\: operator, provider

    Returns\: ()

    (no fields)

  + .. _type-utility-credential-app-v0-model-accounting-feerecordarchive-73610:

    **Choice** `FeeRecord_Archive <type-utility-credential-app-v0-model-accounting-feerecordarchive-73610_>`_

    Archives a fee record\.
    This feature is available as of v0\.2\.1

    Controller\: operator

    Returns\: `FeeRecord_Archive_Result <type-utility-credential-app-v0-model-accounting-feerecordarchiveresult-10707_>`_

    (no fields)

  + .. _type-utility-credential-app-v0-model-accounting-feerecordcalculatereward-29033:

    **Choice** `FeeRecord_CalculateReward <type-utility-credential-app-v0-model-accounting-feerecordcalculatereward-29033_>`_

    When the round is open for issuing, the operator can calculate the actual reward amount\.

    Controller\: operator

    Returns\: `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RewardRecord <type-utility-credential-app-v0-model-accounting-rewardrecord-87937_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - issuingMiningRound
         - `IssuingMiningRound <https://global.canton.network.digitalasset.com/app_dev/api/splice-amulet/Splice-Round.html#type-splice-round-issuingmininground-98097>`_
         - The issuing information for the billing round\.

.. _type-utility-credential-app-v0-model-accounting-rewardrecord-87937:

**template** `RewardRecord <type-utility-credential-app-v0-model-accounting-rewardrecord-87937_>`_

  A reward record that contains information on the rewards earned due to an app transfer\.

  Signatory\: operator, provider

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - operator
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - App operator\.
     * - provider
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Provider of the payment (e\.g\. a Credential issuer that bills a holder)\.
     * - user
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - App user that will receive a reward share (e\.g\. a Credential holder)\.
     * - ccRewardsEarned
       - `Decimal <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135>`_
       - CC rewards earned\. This should match the actual amount that will be paid out\.
     * - round
       - `Round <https://global.canton.network.digitalasset.com/app_dev/api/splice-amulet/Splice-Types.html#type-splice-types-round-16181>`_
       - Round used for billing\.
     * - reference
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Identifier that this billing refers to (e\.g\. a Credential identifier)

  + **Choice** Archive

    Controller\: operator, provider

    Returns\: ()

    (no fields)

  + .. _type-utility-credential-app-v0-model-accounting-rewardrecordarchive-54374:

    **Choice** `RewardRecord_Archive <type-utility-credential-app-v0-model-accounting-rewardrecordarchive-54374_>`_

    Archives a reward record\.
    This feature is available as of v0\.2\.1

    Controller\: operator

    Returns\: `RewardRecord_Archive_Result <type-utility-credential-app-v0-model-accounting-rewardrecordarchiveresult-62587_>`_

    (no fields)

Data Types
----------

.. _type-utility-credential-app-v0-model-accounting-feerecordarchiveresult-10707:

**data** `FeeRecord_Archive_Result <type-utility-credential-app-v0-model-accounting-feerecordarchiveresult-10707_>`_

  Result of ``FeeRecord_Archive``\.

  .. _constr-utility-credential-app-v0-model-accounting-feerecordarchiveresult-56560:

  `FeeRecord_Archive_Result <constr-utility-credential-app-v0-model-accounting-feerecordarchiveresult-56560_>`_

    (no fields)

.. _type-utility-credential-app-v0-model-accounting-rewardrecordarchiveresult-62587:

**data** `RewardRecord_Archive_Result <type-utility-credential-app-v0-model-accounting-rewardrecordarchiveresult-62587_>`_

  Result of ``RewardRecord_Archive``\.

  .. _constr-utility-credential-app-v0-model-accounting-rewardrecordarchiveresult-1386:

  `RewardRecord_Archive_Result <constr-utility-credential-app-v0-model-accounting-rewardrecordarchiveresult-1386_>`_

    (no fields)