FilingCreditsDto

The practice's filing credits, read from Account Hub (shared-account-hub-service
docs/features/FilingCreditPurchases/PLAN.md D9): the balance, the price, the automatic top-up and whether the practice
can pay by Direct Debit.

Properties

Name Type Description
balanceinteger

Credits left. Submitting to HMRC spends them per the cost of the filing type.

Credits left. Submitting to HMRC spends them per the cost of the filing type.

pricingFilingCreditPricingDto
topUpFilingCreditTopUpDto
hasPayableMandateboolean

Whether the practice has a Direct Debit that can collect (buying and switching top-up on need one); null when
Sodium's billing service could not say.

Whether the practice has a Direct Debit that can collect (buying and switching top-up on need one); null when
Sodium's billing service could not say.

JSON Example

{
  "balance": 0,
  "pricing": {
    "creditsPerBlock": 0,
    "blockPricePence": 0,
    "maxBlocksPerPurchase": 0
  },
  "topUp": {
    "autoTopUp": "...",
    "blocksThisMonth": 0,
    "capReachedDate": "2024-01-01",
    "enabledByUserName": "string"
  },
  "hasPayableMandate": false
}

Used By Operations