Utility.Credential.App.V0.Model.Accounting

Templates used for accounting of rewards earned.

Templates

template FeeRecord

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

Signatory: operator, provider

Field	Type	Description
operator	Party	App operator.
provider	Party	Provider of the payment (e.g. a Credential issuer that bills a holder).
user	Party	App user that will receive a reward share (e.g. a Credential holder).
dso	Party	DSO (Decentralized Synchronizer Operations) party.
ccFeesBurned	Decimal	CC fees burned in a single billing cycle.
extraFeaturedAppCcFeesBurned	Decimal	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	Whether the provider is a featured party at the time this record is created.
round	Round	Round used for billing.
reference	Text	Identifier that this billing refers to (e.g. a Credential identifier)

• Choice Archive

  Controller: operator, provider

  Returns: ()

  (no fields)

• Choice FeeRecord_Archive

  Archives a fee record. This feature is available as of v0.2.1

  Controller: operator

  Returns: FeeRecord_Archive_Result

  (no fields)

• Choice FeeRecord_CalculateReward

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

  Controller: operator

  Returns: ContractId RewardRecord

  Field	Type	Description
  issuingMiningRound	IssuingMiningRound	The issuing information for the billing round.

template RewardRecord

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

Signatory: operator, provider

Field	Type	Description
operator	Party	App operator.
provider	Party	Provider of the payment (e.g. a Credential issuer that bills a holder).
user	Party	App user that will receive a reward share (e.g. a Credential holder).
ccRewardsEarned	Decimal	CC rewards earned. This should match the actual amount that will be paid out.
round	Round	Round used for billing.
reference	Text	Identifier that this billing refers to (e.g. a Credential identifier)

• Choice Archive

  Controller: operator, provider

  Returns: ()

  (no fields)

• Choice RewardRecord_Archive

  Archives a reward record. This feature is available as of v0.2.1

  Controller: operator

  Returns: RewardRecord_Archive_Result

  (no fields)

Data Types

data FeeRecord_Archive_Result

Result of FeeRecord_Archive.

FeeRecord_Archive_Result

(no fields)

data RewardRecord_Archive_Result

Result of RewardRecord_Archive.

RewardRecord_Archive_Result

(no fields)