Merge pull request #84 from ministryofjustice/pfs-122-sirius-payments…

…-events

pfs-122: Adds Supervision domain, services, and event

domains/Supervision/events/debt-position-changed/examples/example.json

@@ -0,0 +1,3 @@
+{
+  "clientId": 1
+}

domains/Supervision/events/debt-position-changed/index.md

@@ -0,0 +1,30 @@
+---
+name: debt-position-changed
+version: 0.0.1
+summary: |
+  The debt position for a client has changed
+producers:
+  - opg.supervision.sirius
+consumers:
+  - opg.supervision.finance
+owners:
+  - supervision
+---
+
+## Context
+
+Events on a Supervision client in Sirius can cause the money owed to change and invoices be created. Automated processes in the Supervision Finance service need to be made aware of these changes to the debt position.
+
+## Trigger
+
+An invoice is created in Sirius.
+
+## Effect
+
+Supervision Finance attempts to reapply any excess credit on account for the client whose debt position changed.
+
+<NodeGraph title="Consumer / Producer Diagram" />
+
+<EventExamples />
+
+<Schema />

domains/Supervision/events/debt-position-changed/schema.json

@@ -0,0 +1,13 @@
+{
+  "$id": "https://opg.service.justice.gov.uk/opg.supervision.sirius/debt-position-changed.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "opg.supervision.sirius/debt-position-changed",
+  "type": "object",
+  "properties": {
+    "clientId": {
+      "type": "integer",
+      "description": "The client ID whose debt position changed"
+    }
+  },
+  "required": ["clientId"]
+}

domains/Supervision/index.md

@@ -0,0 +1,11 @@
+---
+name: Supervision
+summary: |
+  Supervision domain
+owners:
+    - supervision
+---
+
+An introduction to Supervision
+
+<NodeGraph title="Domain Graph" />

eventcatalog.config.js

@@ -40,5 +40,11 @@ module.exports = {
       avatarUrl: `${publicPath}make-register.svg`,
       role: 'Team',
     },
+    {
+      id: 'supervision',
+      name: 'Supervision',
+      avatarUrl: `${publicPath}supervision.svg`,
+      role: 'Team',
+    },
   ],
 }

services/opg.supervision.finance/index.md

@@ -0,0 +1,14 @@
+---
+name: opg.supervision.finance
+summary: |
+  OPG's financial case management system for Supervision Orders
+owners:
+    - supervision
+repository:
+  language: Go
+  url: https://github.com/ministryofjustice/opg-sirius-supervision-finance-hub
+---
+
+> The Supervision Finance system is the financial case management system for invoices and payments relating to supervision orders. It is responsible for giving case managers and the cash control team a client-level view of invoices and payments received, as well as recording payment transactions, fee reductions and invoice adjustments.
+
+<NodeGraph />

services/opg.supervision.sirius/index.md

@@ -0,0 +1,14 @@
+---
+name: opg.supervision.sirius
+summary: |
+  OPG's case management system for Supervision Orders
+owners:
+    - supervision
+repository:
+  language: PHP
+  url: https://github.com/ministryofjustice/opg-sirius
+---
+
+> The Sirius system is the core case management system for the Office of the Public Guardian. It is used by just over 1000 casework and customer service staff to administer Lasting Powers of Attorney and Supervision orders under the Mental Capacity Act of 2005. Sirius replaces two legacy case management systems, MERIS (LPA) and CASREC (Supervision). The input to SIRIUS is from scanned paper LPA and Supervision order applications and correspondence.
+
+<NodeGraph />