.. _module-utility-registry-v0-holding-burn-51882:

Utility.Registry.V0.Holding.Burn
================================

Templates
---------

.. _type-utility-registry-v0-holding-burn-acceptedburn-74072:

**template** `AcceptedBurn <type-utility-registry-v0-holding-burn-acceptedburn-74072_>`_

  An accepted burn\.

  Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" burn), (DA\.Internal\.Record\.getField @\"holder\" burn)

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

     * - Field
       - Type
       - Description
     * - burn
       - `Burn <type-utility-registry-v0-holding-burn-burn-46755_>`_
       - Accepted burn payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to burn\.

  + .. _type-utility-registry-v0-holding-burn-acceptedburnexecute-37520:

    **Choice** `AcceptedBurn_Execute <type-utility-registry-v0-holding-burn-acceptedburnexecute-37520_>`_

    Execute an accepted burn\.

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: `AcceptedBurn_Execute_Result <type-utility-registry-v0-holding-burn-acceptedburnexecuteresult-82001_>`_

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

       * - Field
         - Type
         - Description
       * - instrumentConfigurationCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ :ref:`InstrumentConfiguration <type-utility-registry-v0-configuration-instrument-instrumentconfiguration-39219>`
         - Instrument configuration\.
       * - credentialCids
         - \[`ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Credential <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/credential-model/Utility-Credential-V0-Credential.html#type-utility-credential-v0-credential-credential-66032>`_\]
         - Issuer credential cids\.
       * - holdingCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Holding <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Holding.html#type-utility-registry-holding-v0-holding-holding-15575>`_
         - Holding to burn\.

  + .. _type-utility-registry-v0-holding-burn-acceptedburnfail-50760:

    **Choice** `AcceptedBurn_Fail <type-utility-registry-v0-holding-burn-acceptedburnfail-50760_>`_

    Fail an accepted burn\.

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: `AcceptedBurn_Fail_Result <type-utility-registry-v0-holding-burn-acceptedburnfailresult-85433_>`_

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

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for failure\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn), (DA\.Internal\.Record\.getField @\"holder\" burn)

    Returns\: ()

    (no fields)

.. _type-utility-registry-v0-holding-burn-burnoffer-71500:

**template** `BurnOffer <type-utility-registry-v0-holding-burn-burnoffer-71500_>`_

  An offer to burn a holding

  Signatory\: (DA\.Internal\.Record\.getField @\"provider\" burn), (DA\.Internal\.Record\.getField @\"registrar\" burn)

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

     * - Field
       - Type
       - Description
     * - burn
       - `Burn <type-utility-registry-v0-holding-burn-burn-46755_>`_
       - Burn offer payload\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"provider\" burn), (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-burn-burnofferaccept-93282:

    **Choice** `BurnOffer_Accept <type-utility-registry-v0-holding-burn-burnofferaccept-93282_>`_

    Accepts a burn offer\.

    Controller\: (DA\.Internal\.Record\.getField @\"holder\" burn)

    Returns\: `BurnOffer_Accept_Result <type-utility-registry-v0-holding-burn-burnofferacceptresult-18783_>`_

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

       * - Field
         - Type
         - Description
       * - holdingLabel
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Label of the holding to burn\.

  + .. _type-utility-registry-v0-holding-burn-burnoffercancel-91732:

    **Choice** `BurnOffer_Cancel <type-utility-registry-v0-holding-burn-burnoffercancel-91732_>`_

    Cancels a burn offer\.

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: `BurnOffer_Cancel_Result <type-utility-registry-v0-holding-burn-burnoffercancelresult-83981_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-burn-burnofferreject-84815:

    **Choice** `BurnOffer_Reject <type-utility-registry-v0-holding-burn-burnofferreject-84815_>`_

    Rejects a burn offer\.

    Controller\: (DA\.Internal\.Record\.getField @\"holder\" burn)

    Returns\: `BurnOffer_Reject_Result <type-utility-registry-v0-holding-burn-burnofferrejectresult-2032_>`_

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

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for rejection\.

.. _type-utility-registry-v0-holding-burn-burnrequest-25675:

**template** `BurnRequest <type-utility-registry-v0-holding-burn-burnrequest-25675_>`_

  A request to burn a holding

  Signatory\: (DA\.Internal\.Record\.getField @\"provider\" burn), (DA\.Internal\.Record\.getField @\"holder\" burn)

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

     * - Field
       - Type
       - Description
     * - burn
       - `Burn <type-utility-registry-v0-holding-burn-burn-46755_>`_
       - Burn request payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to burn\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"provider\" burn), (DA\.Internal\.Record\.getField @\"holder\" burn)

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-burn-burnrequestaccept-36027:

    **Choice** `BurnRequest_Accept <type-utility-registry-v0-holding-burn-burnrequestaccept-36027_>`_

    Accepts a burn request\.

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: `BurnRequest_Accept_Result <type-utility-registry-v0-holding-burn-burnrequestacceptresult-96020_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-burn-burnrequestcancel-34569:

    **Choice** `BurnRequest_Cancel <type-utility-registry-v0-holding-burn-burnrequestcancel-34569_>`_

    Cancels a burn request\.

    Controller\: (DA\.Internal\.Record\.getField @\"holder\" burn)

    Returns\: `BurnRequest_Cancel_Result <type-utility-registry-v0-holding-burn-burnrequestcancelresult-88206_>`_

    (no fields)

  + .. _type-utility-registry-v0-holding-burn-burnrequestreject-59250:

    **Choice** `BurnRequest_Reject <type-utility-registry-v0-holding-burn-burnrequestreject-59250_>`_

    Rejects a burn request\.

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: `BurnRequest_Reject_Result <type-utility-registry-v0-holding-burn-burnrequestrejectresult-36379_>`_

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

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reason for rejection\.

.. _type-utility-registry-v0-holding-burn-executedburn-40176:

**template** `ExecutedBurn <type-utility-registry-v0-holding-burn-executedburn-40176_>`_

  An executed burn\.

  Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

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

     * - Field
       - Type
       - Description
     * - burn
       - `Burn <type-utility-registry-v0-holding-burn-burn-46755_>`_
       - Burn request payload\.
     * - holdingLabel
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Label of the holding to burn\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-burn-executedburndelete-21879:

    **Choice** `ExecutedBurn_Delete <type-utility-registry-v0-holding-burn-executedburndelete-21879_>`_

    Deletes an executed burn\.

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: `ExecutedBurn_Delete_Result <type-utility-registry-v0-holding-burn-executedburndeleteresult-43136_>`_

    (no fields)

.. _type-utility-registry-v0-holding-burn-failedburn-29918:

**template** `FailedBurn <type-utility-registry-v0-holding-burn-failedburn-29918_>`_

  A failed burn\.

  Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

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

     * - Field
       - Type
       - Description
     * - burn
       - `Burn <type-utility-registry-v0-holding-burn-burn-46755_>`_
       - Rejected burn payload\.
     * - reason
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Reason for failure\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-burn-failedburndelete-61833:

    **Choice** `FailedBurn_Delete <type-utility-registry-v0-holding-burn-failedburndelete-61833_>`_

    Deletes a rejected burn\.

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: `FailedBurn_Delete_Result <type-utility-registry-v0-holding-burn-failedburndeleteresult-73970_>`_

    (no fields)

.. _type-utility-registry-v0-holding-burn-rejectedburn-12829:

**template** `RejectedBurn <type-utility-registry-v0-holding-burn-rejectedburn-12829_>`_

  A rejected burn\.

  Signatory\: (DA\.Internal\.Record\.getField @\"registrar\" burn), (DA\.Internal\.Record\.getField @\"holder\" burn)

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

     * - Field
       - Type
       - Description
     * - burn
       - `Burn <type-utility-registry-v0-holding-burn-burn-46755_>`_
       - Rejected burn payload\.
     * - reason
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Reason for rejection\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn), (DA\.Internal\.Record\.getField @\"holder\" burn)

    Returns\: ()

    (no fields)

  + .. _type-utility-registry-v0-holding-burn-rejectedburndelete-50564:

    **Choice** `RejectedBurn_Delete <type-utility-registry-v0-holding-burn-rejectedburndelete-50564_>`_

    Deletes a rejected burn\.

    Controller\: (DA\.Internal\.Record\.getField @\"registrar\" burn)

    Returns\: `RejectedBurn_Delete_Result <type-utility-registry-v0-holding-burn-rejectedburndeleteresult-87929_>`_

    (no fields)

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

.. _type-utility-registry-v0-holding-burn-acceptedburnexecuteresult-82001:

**data** `AcceptedBurn_Execute_Result <type-utility-registry-v0-holding-burn-acceptedburnexecuteresult-82001_>`_

  Result of ``AcceptedBurn_Execute``\.

  .. _constr-utility-registry-v0-holding-burn-acceptedburnexecuteresult-91036:

  `AcceptedBurn_Execute_Result <constr-utility-registry-v0-holding-burn-acceptedburnexecuteresult-91036_>`_

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

       * - Field
         - Type
         - Description
       * - executedBurnCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `ExecutedBurn <type-utility-registry-v0-holding-burn-executedburn-40176_>`_
         - Executed burn\.

.. _type-utility-registry-v0-holding-burn-acceptedburnfailresult-85433:

**data** `AcceptedBurn_Fail_Result <type-utility-registry-v0-holding-burn-acceptedburnfailresult-85433_>`_

  Result of ``AcceptedBurn_Fail``\.

  .. _constr-utility-registry-v0-holding-burn-acceptedburnfailresult-76182:

  `AcceptedBurn_Fail_Result <constr-utility-registry-v0-holding-burn-acceptedburnfailresult-76182_>`_

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

       * - Field
         - Type
         - Description
       * - failedBurnCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `FailedBurn <type-utility-registry-v0-holding-burn-failedburn-29918_>`_
         - Failed burn\.

.. _type-utility-registry-v0-holding-burn-burn-46755:

**data** `Burn <type-utility-registry-v0-holding-burn-burn-46755_>`_

  Burn payload\.

  .. _constr-utility-registry-v0-holding-burn-burn-17772:

  `Burn <constr-utility-registry-v0-holding-burn-burn-17772_>`_

    .. 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>`_
         - Utility operator\.
       * - provider
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Provider of the initiator of the burn\.
       * - registrar
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Instrument registrar\.
       * - instrumentIdentifier
         - `InstrumentIdentifier <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/registry-holding-model/Utility-Registry-Holding-V0-Types.html#type-utility-registry-holding-v0-types-instrumentidentifier-9531>`_
         - Instrument to burn\.
       * - amount
         - `Decimal <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135>`_
         - Amount to burn\.
       * - holder
         - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
         - Owner of the holding to burn\.
       * - reference
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reference for the burn\.
       * - batch
         - :ref:`Batch <type-utility-registry-v0-types-batch-47769>`
         - Batch the burn belongs to\.

.. _type-utility-registry-v0-holding-burn-burnofferacceptresult-18783:

**data** `BurnOffer_Accept_Result <type-utility-registry-v0-holding-burn-burnofferacceptresult-18783_>`_

  Result of ``BurnOffer_Accept``\.

  .. _constr-utility-registry-v0-holding-burn-burnofferacceptresult-73626:

  `BurnOffer_Accept_Result <constr-utility-registry-v0-holding-burn-burnofferacceptresult-73626_>`_

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

       * - Field
         - Type
         - Description
       * - acceptedBurnCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `AcceptedBurn <type-utility-registry-v0-holding-burn-acceptedburn-74072_>`_
         - Accepted burn\.

.. _type-utility-registry-v0-holding-burn-burnoffercancelresult-83981:

**data** `BurnOffer_Cancel_Result <type-utility-registry-v0-holding-burn-burnoffercancelresult-83981_>`_

  Result of ``BurnOffer_Cancel``\.

  .. _constr-utility-registry-v0-holding-burn-burnoffercancelresult-48728:

  `BurnOffer_Cancel_Result <constr-utility-registry-v0-holding-burn-burnoffercancelresult-48728_>`_

    (no fields)

.. _type-utility-registry-v0-holding-burn-burnofferrejectresult-2032:

**data** `BurnOffer_Reject_Result <type-utility-registry-v0-holding-burn-burnofferrejectresult-2032_>`_

  Result of ``BurnOffer_Reject``\.

  .. _constr-utility-registry-v0-holding-burn-burnofferrejectresult-84545:

  `BurnOffer_Reject_Result <constr-utility-registry-v0-holding-burn-burnofferrejectresult-84545_>`_

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

       * - Field
         - Type
         - Description
       * - rejectedBurnCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RejectedBurn <type-utility-registry-v0-holding-burn-rejectedburn-12829_>`_
         - Rejected burn\.

.. _type-utility-registry-v0-holding-burn-burnrequestacceptresult-96020:

**data** `BurnRequest_Accept_Result <type-utility-registry-v0-holding-burn-burnrequestacceptresult-96020_>`_

  Result of ``BurnRequest_Accept``\.

  .. _constr-utility-registry-v0-holding-burn-burnrequestacceptresult-22429:

  `BurnRequest_Accept_Result <constr-utility-registry-v0-holding-burn-burnrequestacceptresult-22429_>`_

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

       * - Field
         - Type
         - Description
       * - acceptedBurnCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `AcceptedBurn <type-utility-registry-v0-holding-burn-acceptedburn-74072_>`_
         - Accepted burn\.

.. _type-utility-registry-v0-holding-burn-burnrequestcancelresult-88206:

**data** `BurnRequest_Cancel_Result <type-utility-registry-v0-holding-burn-burnrequestcancelresult-88206_>`_

  Result of ``BurnRequest_Cancel``\.

  .. _constr-utility-registry-v0-holding-burn-burnrequestcancelresult-27447:

  `BurnRequest_Cancel_Result <constr-utility-registry-v0-holding-burn-burnrequestcancelresult-27447_>`_

    (no fields)

.. _type-utility-registry-v0-holding-burn-burnrequestrejectresult-36379:

**data** `BurnRequest_Reject_Result <type-utility-registry-v0-holding-burn-burnrequestrejectresult-36379_>`_

  Result of ``BurnRequest_Reject``\.

  .. _constr-utility-registry-v0-holding-burn-burnrequestrejectresult-85390:

  `BurnRequest_Reject_Result <constr-utility-registry-v0-holding-burn-burnrequestrejectresult-85390_>`_

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

       * - Field
         - Type
         - Description
       * - rejectedBurnCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RejectedBurn <type-utility-registry-v0-holding-burn-rejectedburn-12829_>`_
         - Rejected burn\.

.. _type-utility-registry-v0-holding-burn-executedburndeleteresult-43136:

**data** `ExecutedBurn_Delete_Result <type-utility-registry-v0-holding-burn-executedburndeleteresult-43136_>`_

  Result of ``ExecutedBurn_Delete``\.

  .. _constr-utility-registry-v0-holding-burn-executedburndeleteresult-5071:

  `ExecutedBurn_Delete_Result <constr-utility-registry-v0-holding-burn-executedburndeleteresult-5071_>`_

    (no fields)

.. _type-utility-registry-v0-holding-burn-failedburndeleteresult-73970:

**data** `FailedBurn_Delete_Result <type-utility-registry-v0-holding-burn-failedburndeleteresult-73970_>`_

  Result of ``FailedBurn_Delete``\.

  .. _constr-utility-registry-v0-holding-burn-failedburndeleteresult-67685:

  `FailedBurn_Delete_Result <constr-utility-registry-v0-holding-burn-failedburndeleteresult-67685_>`_

    (no fields)

.. _type-utility-registry-v0-holding-burn-rejectedburndeleteresult-87929:

**data** `RejectedBurn_Delete_Result <type-utility-registry-v0-holding-burn-rejectedburndeleteresult-87929_>`_

  Result of ``RejectedBurn_Delete``\.

  .. _constr-utility-registry-v0-holding-burn-rejectedburndeleteresult-58970:

  `RejectedBurn_Delete_Result <constr-utility-registry-v0-holding-burn-rejectedburndeleteresult-58970_>`_

    (no fields)