logoOPG Event Store

credit-on-account
v0.0.1

The client has credit on account that cannot be applied to any open invoice or debt

Context

When a payment or other credit is received for a client but is greater than the client's outstanding debt, that credit is retained on their account. This may need to result in a refund to the client.

Trigger

A client's credit balance is larger than their outstanding debt position.

Effect

Sirius Supervision creates a Refund Review task on the client.

Consumer / Producer Diagram

Open in Visualiser →

Examples

1{
2  "clientId": 1,
3  "creditRemaining": 10000
4}
5
credit-on-account Schema (json)
{
  "$id": "https://opg.service.justice.gov.uk/opg.supervision.sirius/credit-on-account.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "opg.supervision.sirius/credit-on-account",
  "type": "object",
  "properties": {
    "clientId": {
      "type": "integer",
      "description": "The client ID whose account is in credit"
    },
    "creditRemaining": {
      "type": "integer",
      "description": "The amount of unapplied credit on account (in pennies)"
    }
  },
  "required": ["clientId", "creditRemaining"]
}
Edit this pageLast updated on 2024/11/22