Sfi 2199 subscribe to submitted payment requests

app/constants/account-codes.js

@@ -0,0 +1,3 @@
+module.exports = {
+  SFI_GROSS_VALUE_AP: 'SOS273'
+}

app/constants/currencies.js

@@ -0,0 +1,3 @@
+module.exports = {
+  GBP: 'GBP'
+}

app/constants/delivery-bodies.js

@@ -0,0 +1,3 @@
+module.exports = {
+  RP00: 'RP00'
+}

app/constants/descriptions.js

@@ -0,0 +1,3 @@
+module.exports = {
+  GROSS_VALUE: 'G00 - Gross value of claim'
+}

app/constants/fund-codes.js

@@ -0,0 +1,3 @@
+module.exports = {
+  DRD10: 'DRD10'
+}

app/constants/funding-code-names.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ARABLE_SOIL_INTRODUCTORY: 'Arable and horticultural soils: Introductory'
+}

app/constants/funding-codes.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ARABLE_SOIL_INTRODUCTORY: '80001'
+}

app/constants/funding-options.js

@@ -0,0 +1,7 @@
+const { ARABLE_SOIL_INTRODUCTORY: ARABLE_SOIL_INTRODUCTORY_CODE } = require('./funding-codes')
+const { ARABLE_SOIL_INTRODUCTORY } = require('./funding-code-names')
+
+module.exports = [{
+  fundingCode: ARABLE_SOIL_INTRODUCTORY_CODE,
+  name: ARABLE_SOIL_INTRODUCTORY
+}]

app/constants/ledgers.js

@@ -0,0 +1,4 @@
+module.exports = {
+  AP: 'AP',
+  AR: 'AR'
+}

app/constants/payment-request-numbers.js

@@ -0,0 +1,4 @@
+module.exports = {
+  FIRST_PAYMENT: 1,
+  POST_PAYMENT_ADJUSTMENT: 2
+}

app/constants/schedules.js

@@ -0,0 +1,5 @@
+module.exports = {
+  QUARTERLY: 'Q4',
+  MONTHLY: 'M12',
+  THREE_DAY_QUARTERLY: 'T4'
+}

app/constants/scheme-ids.js

@@ -0,0 +1,7 @@
+module.exports = {
+  SFI: 1,
+  SFI_PILOT: 2,
+  LUMP_SUMS: 3,
+  LNR: 4,
+  VET_VISITS: 5
+}

app/constants/scheme-names.js

@@ -0,0 +1,7 @@
+module.exports = {
+  LNR: 'LNR',
+  LUMP_SUMS: 'Lump Sums',
+  SFI: 'SFI',
+  SFI_PILOT: 'SFIP',
+  VET_VISITS: 'Vet Visits'
+}

app/constants/schemes.js

@@ -0,0 +1,36 @@
+const {
+  LNR: LNR_ID,
+  LUMP_SUMS: LUMP_SUMS_ID,
+  SFI: SFI_ID,
+  SFI_PILOT: SFI_PILOT_ID,
+  VET_VISITS: VET_VISITS_ID
+} = require('./scheme-ids')
+
+const {
+  LNR,
+  LUMP_SUMS,
+  SFI,
+  SFI_PILOT,
+  VET_VISITS
+} = require('./scheme-names')
+
+module.exports = [{
+  schemeId: LNR_ID,
+  name: LNR
+},
+{
+  schemeId: LUMP_SUMS_ID,
+  name: LUMP_SUMS
+},
+{
+  schemeId: SFI_ID,
+  name: SFI
+},
+{
+  schemeId: SFI_PILOT_ID,
+  name: SFI_PILOT
+},
+{
+  schemeId: VET_VISITS_ID,
+  name: VET_VISITS
+}]

app/constants/source-systems.js

@@ -0,0 +1,3 @@
+module.exports = {
+  SFI: 'SFI'
+}

app/constants/statuses.js

@@ -0,0 +1,4 @@
+module.exports = {
+  IN_PROGRESS: 'In progress',
+  COMPLETED: 'Completed'
+}

app/data/models/payment-request.js

@@ -1,17 +1,19 @@
 module.exports = (sequelize, DataTypes) => {
   const paymentRequest = sequelize.define('paymentRequest', {
     paymentRequestId: { type: DataTypes.INTEGER, primaryKey: true, autoIncrement: true },
+    invoiceNumber: DataTypes.STRING,
+    schemeId: DataTypes.INTEGER,
     agreementNumber: DataTypes.STRING,
     contractNumber: DataTypes.STRING,
     correlationId: DataTypes.UUID,
     currency: DataTypes.STRING,
     deliveryBody: DataTypes.STRING,
     dueDate: DataTypes.STRING,
-    invoiceNumber: DataTypes.STRING,
     marketingYear: DataTypes.INTEGER,
+    received: DataTypes.DATE,
     referenceId: DataTypes.UUID,
     schedule: DataTypes.STRING,
-    sitiAgriInvoiceNumber: DataTypes.STRING,
+    status: DataTypes.STRING,
     submitted: DataTypes.DATE,
     value: DataTypes.INTEGER
   },

app/inbound/get-completed-payment-request-by-reference-id.js

@@ -0,0 +1,15 @@
+const db = require('../data')
+const { COMPLETED } = require('../constants/statuses')
+
+const getCompletedPaymentRequestByReferenceId = async (referenceId, transaction) => {
+  return db.paymentRequest.findOne({
+    transaction,
+    lock: true,
+    where: {
+      referenceId,
+      status: COMPLETED
+    }
+  })
+}
+
+module.exports = getCompletedPaymentRequestByReferenceId

app/inbound/index.js

@@ -0,0 +1,3 @@
+const processSubmitPaymentRequest = require('./process-submit-payment-request')
+
+module.exports = processSubmitPaymentRequest

app/inbound/process-submit-payment-request.js

@@ -0,0 +1,29 @@
+const db = require('../data')
+
+const { COMPLETED } = require('../constants/statuses')
+const getCompletedPaymentRequestByReferenceId = require('./get-completed-payment-request-by-reference-id')
+const saveInvoiceNumber = require('./save-invoice-number')
+const savePaymentRequest = require('./save-payment-request')
+const saveInvoiceLines = require('./save-invoice-lines')
+
+const processSubmitPaymentRequest = async (paymentRequest) => {
+  const transaction = await db.sequelize.transaction()
+  try {
+    const existingPaymentRequest = await getCompletedPaymentRequestByReferenceId(paymentRequest.referenceId, transaction)
+
+    if (existingPaymentRequest) {
+      console.info(`Duplicate payment request received, skipping ${existingPaymentRequest.referenceId}`)
+      await transaction.rollback()
+    } else {
+      await saveInvoiceNumber(paymentRequest.invoiceNumber, transaction)
+      const savedPaymentRequest = await savePaymentRequest({ ...paymentRequest, status: COMPLETED }, transaction)
+      await saveInvoiceLines(paymentRequest.invoiceLines, savedPaymentRequest.paymentRequestId, transaction)
+      await transaction.commit()
+    }
+  } catch (error) {
+    await transaction.rollback()
+    throw (error)
+  }
+}
+
+module.exports = processSubmitPaymentRequest

app/inbound/save-invoice-lines.js

@@ -0,0 +1,11 @@
+const db = require('../data')
+
+const saveInvoiceLines = async (invoiceLines, paymentRequestId, transaction) => {
+  for (const invoiceLine of invoiceLines) {
+    delete invoiceLine.invoiceLineId
+    invoiceLine.fundingCode = invoiceLine.schemeCode
+    await db.invoiceLine.create({ ...invoiceLine, paymentRequestId }, { transaction })
+  }
+}
+
+module.exports = saveInvoiceLines

app/inbound/save-invoice-number.js

@@ -0,0 +1,13 @@
+const db = require('../data')
+const reverseEngineerInvoiceNumber = require('../processing/reverse-engineer-invoice-number')
+
+const saveInvoiceNumber = async (invoiceNumber, transaction) => {
+  await db.invoiceNumber.create({
+    invoiceNumber,
+    originalInvoiceNumber: reverseEngineerInvoiceNumber(invoiceNumber)
+  },
+  { transaction }
+  )
+}
+
+module.exports = saveInvoiceNumber

app/inbound/save-payment-request.js

@@ -0,0 +1,8 @@
+const db = require('../data')
+
+const savePaymentRequest = async (paymentRequest, transaction) => {
+  delete paymentRequest.paymentRequestId
+  return db.paymentRequest.create({ ...paymentRequest, received: new Date() }, { transaction })
+}
+
+module.exports = savePaymentRequest

app/messaging/process-submit-message.js

@@ -1,5 +1,11 @@
+const util = require('util')
+const processSubmitPaymentRequest = require('../inbound')
+
 const processSubmitMessage = async (message, receiver) => {
   try {
+    const paymentRequest = message.body
+    console.log('Payment request submitted:', util.inspect(paymentRequest, false, null, true))
+    await processSubmitPaymentRequest(paymentRequest)
     await receiver.completeMessage(message)
   } catch (err) {
     console.error('Unable to process submit message:', err)

app/processing/reverse-engineer-invoice-number.js

@@ -0,0 +1,5 @@
+const reverseEngineerInvoiceNumber = (invoiceNumber) => {
+  return `original${invoiceNumber.slice(0, 5)}`
+}
+
+module.exports = reverseEngineerInvoiceNumber

changelog/db.changelog-1.2.xml

@@ -0,0 +1,65 @@
+<?xml version="1.1" encoding="UTF-8" standalone="no"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog" xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext" xmlns:pro="http://www.liquibase.org/xml/ns/pro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd http://www.liquibase.org/xml/ns/pro http://www.liquibase.org/xml/ns/pro/liquibase-pro-3.9.xsd http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.9.xsd">
+ <changeSet author="Marc Templeton" id="1">
+    <tagDatabase tag="v1.1.0" />
+  </changeSet>
+  <changeSet author="Marc Templeton" id="2">
+    <modifyDataType tableName="fundings" columnName="areaClaimed" newDataType="DECIMAL(11,4)" />
+    <rollback>
+      <modifyDataType tableName="fundings" columnName="areaClaimed" newDataType="DECIMAL(19,4)" />
+    </rollback>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="3">
+    <insert tableName="schemes">
+      <column name="schemeId" value="1" />
+      <column name="name" value="SFI" />
+    </insert>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="4">
+    <insert tableName="schemes">
+      <column name="schemeId" value="2" />
+      <column name="name" value="SFI Pilot" />
+    </insert>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="5">
+    <insert tableName="schemes">
+      <column name="schemeId" value="3" />
+      <column name="name" value="Lump Sums" />
+    </insert>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="6">
+    <insert tableName="schemes">
+      <column name="schemeId" value="4" />
+      <column name="name" value="LNR" />
+    </insert>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="7">
+    <insert tableName="schemes">
+      <column name="schemeId" value="5" />
+      <column name="name" value="Vet Visits" />
+    </insert>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="8">
+    <modifyDataType tableName="fundingOptions" columnName="name" newDataType="VARCHAR(60)" />
+    <rollback>
+      <modifyDataType tableName="fundingOptions" columnName="name" newDataType="VARCHAR(30)" />
+    </rollback>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="9">
+    <insert tableName="fundingOptions">
+      <column name="fundingCode" value="80001" />
+      <column name="name" value="Arable and horticultural soils: Introductory" />
+    </insert>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="10">
+    <addColumn tableName="paymentRequests">
+      <column afterColumn="marketingYear" name="received" type="TIMESTAMP" />
+      <column afterColumn="schedule" name="status" type="VARCHAR(20)" />
+    </addColumn>
+  </changeSet>
+  <changeSet author="Marc Templeton" id="11">
+    <dropColumn tableName="paymentRequests">
+      <column name="sitiAgriInvoiceNumber" />
+    </dropColumn>
+  </changeSet>
+</databaseChangeLog>

changelog/db.changelog.xml

@@ -6,4 +6,5 @@
                       http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.8.xsd">  
   <include file="changelog/db.changelog-1.0.xml"/>
   <include file="changelog/db.changelog-1.1.xml"/>
+  <include file="changelog/db.changelog-1.2.xml"/>
 </databaseChangeLog>