Merge pull request #29 from cardano-foundation/api2-reconcilation-req…

…uest feat: API2: source / ERP level reconcilation.
cardano-foundation · Sep 11, 2024 · 38bfdc2 · 38bfdc2
2 parents 67936ec + 8f00400
commit 38bfdc2
Show file tree

Hide file tree

Showing 133 changed files with 2,243 additions and 612 deletions.
diff --git a/...ain/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Account.java b/...ain/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Account.java
@@ -2,7 +2,8 @@
 
 import jakarta.validation.constraints.Size;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
+import org.javers.core.metamodel.annotation.DiffInclude;
 
 import java.util.Optional;
 
@@ -14,7 +15,8 @@
 @NoArgsConstructor
 public class Account {
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
+
     private String code;
 
     @Builder.Default

diff --git a/.../java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/CostCenter.java b/.../java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/CostCenter.java
@@ -2,7 +2,8 @@
 
 import jakarta.validation.constraints.Size;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
+import org.javers.core.metamodel.annotation.DiffInclude;
 
 import java.util.Optional;
 
@@ -14,7 +15,8 @@
 @NoArgsConstructor
 public class CostCenter {
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
+
     private @Size(min = 1, max =  255) String customerCode;
 
     @Builder.Default

diff --git a/...ava/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Counterparty.java b/...ava/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Counterparty.java
@@ -3,7 +3,8 @@
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Size;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
+import org.javers.core.metamodel.annotation.DiffInclude;
 
 import java.util.Optional;
 
@@ -17,10 +18,12 @@
 @NoArgsConstructor
 public class Counterparty {
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
+
     private @Size(min = 1, max =  255) @NotBlank String customerCode;
 
     @Builder.Default
+
     private Type type = VENDOR;
 
     @Builder.Default

diff --git a/...in/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Currency.java b/...in/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Currency.java
@@ -2,7 +2,7 @@
 
 import jakarta.validation.constraints.NotBlank;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
 
 import java.util.Optional;
 
@@ -15,7 +15,7 @@
 public class Currency {
 
     @NotBlank
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     private String customerCode;
 
     @Builder.Default

diff --git a/...in/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Document.java b/...in/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Document.java
@@ -4,7 +4,7 @@
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
 
 import java.util.Optional;
 
@@ -17,21 +17,18 @@
 @EqualsAndHashCode
 public class Document {
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     @Size(min = 1, max =  255) @NotBlank private String number;
 
     @NotNull
-    @LOB_ERPSourceVersionRelevant
     private Currency currency;
 
     @Builder.Default
     @NotNull
-    @LOB_ERPSourceVersionRelevant
     private Optional<Vat> vat = Optional.empty();
 
     @Builder.Default
     @NotNull
-    @LOB_ERPSourceVersionRelevant
     private Optional<Counterparty> counterparty = Optional.empty();
 
 }
diff --git a/...cardanofoundation/lob/app/accounting_reporting_core/domain/core/LedgerDispatchStatus.java b/...cardanofoundation/lob/app/accounting_reporting_core/domain/core/LedgerDispatchStatus.java
@@ -12,7 +12,7 @@ public enum LedgerDispatchStatus {
 
     COMPLETED, // tx hash is ready and provided and in addition we have decent finality score to consider it completed
 
-    FINALIZED; // finalised on blockchain(s) - tx hash (36 hours)
+    FINALIZED; // finalised on blockchain(s) - tx hash (12 hours)
 
     public static Set<LedgerDispatchStatus> allDispatchedStatuses() {
         return Set.of(MARK_DISPATCH, DISPATCHED, COMPLETED, FINALIZED);

diff --git a/...ava/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Organisation.java b/...ava/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Organisation.java
@@ -3,7 +3,7 @@
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Size;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
 
 import java.util.Optional;
 
@@ -14,7 +14,7 @@
 @NoArgsConstructor
 public class Organisation {
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     @Size(min = 1, max =  255) @NotBlank  private String id;
 
     @Builder.Default

diff --git a/...ain/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Project.java b/...ain/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Project.java
@@ -1,21 +1,19 @@
 package org.cardanofoundation.lob.app.accounting_reporting_core.domain.core;
 
 import jakarta.validation.constraints.Size;
-import lombok.AllArgsConstructor;
-import lombok.Builder;
-import lombok.EqualsAndHashCode;
-import lombok.Getter;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import lombok.*;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
 
 import java.util.Optional;
 
 @AllArgsConstructor
 @Getter
 @Builder(toBuilder = true)
 @EqualsAndHashCode
+@NoArgsConstructor
 public class Project {
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     private @Size(min = 1, max =  255) String customerCode;
 
     @Builder.Default

diff --git a/...va/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Reconcilation.java b/...va/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Reconcilation.java
@@ -0,0 +1,22 @@
+package org.cardanofoundation.lob.app.accounting_reporting_core.domain.core;
+
+import jakarta.persistence.Enumerated;
+import lombok.*;
+
+import static jakarta.persistence.EnumType.STRING;
+
+@AllArgsConstructor
+@Getter
+@Builder(toBuilder = true)
+@EqualsAndHashCode
+@ToString
+@NoArgsConstructor
+public class Reconcilation {
+
+    @Enumerated(STRING)
+    private ReconcilationCode source;
+
+    @Enumerated(STRING)
+    private ReconcilationCode sink;
+
+}
diff --git a/...e/domain/core/TransactionVersionAlgo.java → ...g_core/domain/core/ReconcilationCode.java b/...e/domain/core/TransactionVersionAlgo.java → ...g_core/domain/core/ReconcilationCode.java
@@ -1,8 +1,8 @@
 package org.cardanofoundation.lob.app.accounting_reporting_core.domain.core;
 
-public enum TransactionVersionAlgo {
+public enum ReconcilationCode {
 
-    ERP_SOURCE,
-    BLOCKCHAIN_SINK
+    OK,
+    NOK
 
 }
diff --git a/.../cardanofoundation/lob/app/accounting_reporting_core/domain/core/ReconcilationStatus.java b/.../cardanofoundation/lob/app/accounting_reporting_core/domain/core/ReconcilationStatus.java
@@ -0,0 +1,13 @@
+package org.cardanofoundation.lob.app.accounting_reporting_core.domain.core;
+
+public enum ReconcilationStatus {
+
+    CREATED, // reconcilation is created but not started yet meaning no chunks sending started yet
+
+    STARTED, // reconcilation is started and first chunk event is sent
+
+    FAILED, // reconcilation is failed
+
+    COMPLETED, // reconcilation is completed, we see this on the last chunk event sent
+
+}
diff --git a/...java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Transaction.java b/...java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Transaction.java
@@ -5,7 +5,7 @@
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Size;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
 
 import java.time.LocalDate;
 import java.time.YearMonth;
@@ -23,25 +23,24 @@
 public class Transaction {
 
     @NotBlank
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     private String id;
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     @Size(min = 1, max =  255) @NotBlank String internalTransactionNumber;
 
     @NotBlank
     private String batchId;
 
     @NotNull
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     private LocalDate entryDate;
 
     @NotNull
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     private TransactionType transactionType;
 
     @NotNull
-    @LOB_ERPSourceVersionRelevant
     private Organisation organisation;
 
     @NotNull

diff --git a/.../org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/TransactionItem.java b/.../org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/TransactionItem.java
@@ -4,7 +4,7 @@
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.PositiveOrZero;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
 
 import java.math.BigDecimal;
 import java.util.Optional;
@@ -19,41 +19,36 @@
 @EqualsAndHashCode
 public class TransactionItem {
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     @NotBlank private String id;
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     @NotNull private BigDecimal amountFcy;
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     @NotNull private BigDecimal amountLcy;
 
     @Builder.Default
-    @LOB_ERPSourceVersionRelevant
     private Optional<Account> accountDebit = Optional.empty();
 
     @Builder.Default
-    @LOB_ERPSourceVersionRelevant
     private Optional<Account> accountCredit = Optional.empty();
 
     @Builder.Default
     private Optional<AccountEvent> accountEvent = Optional.empty();
 
     @Builder.Default
-    @LOB_ERPSourceVersionRelevant
     private Optional<Project> project = Optional.empty();
 
     @Builder.Default
-    @LOB_ERPSourceVersionRelevant
     private Optional<CostCenter> costCenter = Optional.empty();
 
     @Builder.Default
-    @LOB_ERPSourceVersionRelevant
     private Optional<Document> document = Optional.empty(); // initially we allow empty but later as part of business rules we check if document is present
 
     @NotNull
     @PositiveOrZero
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     private BigDecimal fxRate;
 
     public static String id(String transactionId,

diff --git a/...rting_core/domain/core/ViolationCode.java → ...domain/core/TransactionViolationCode.java b/...rting_core/domain/core/ViolationCode.java → ...domain/core/TransactionViolationCode.java
@@ -1,6 +1,6 @@
 package org.cardanofoundation.lob.app.accounting_reporting_core.domain.core;
 
-public enum ViolationCode {
+public enum TransactionViolationCode {
 
     DOCUMENT_MUST_BE_PRESENT,
     TX_CANNOT_BE_ALTERED,

diff --git a/...rc/main/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Vat.java b/...rc/main/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Vat.java
@@ -3,7 +3,7 @@
 import jakarta.validation.constraints.NotBlank;
 import jakarta.validation.constraints.Size;
 import lombok.*;
-import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOB_ERPSourceVersionRelevant;
+import org.cardanofoundation.lob.app.accounting_reporting_core.domain.core.annotations.LOBVersionSourceRelevant;
 
 import java.math.BigDecimal;
 import java.util.Optional;
@@ -16,7 +16,7 @@
 @NoArgsConstructor
 public class Vat {
 
-    @LOB_ERPSourceVersionRelevant
+    @LOBVersionSourceRelevant
     @Size(min = 1, max =  255) @NotBlank private String customerCode;
 
     @Builder.Default

diff --git a/...n/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Violation.java b/...n/java/org/cardanofoundation/lob/app/accounting_reporting_core/domain/core/Violation.java
@@ -6,25 +6,25 @@
 public record Violation(Severity severity,
                         Source source,
                         Optional<String> txItemId,
-                        ViolationCode code,
+                        TransactionViolationCode code,
                         String processorModule,
                         Map<String, Object> bag) {
 
     public static Violation create(Severity severity,
                                    Source source,
-                                   ViolationCode violationCode,
+                                   TransactionViolationCode transactionViolationCode,
                                    String processorModule,
                                    Map<String, Object> bag) {
-        return new Violation(severity, source, Optional.empty(), violationCode, processorModule, bag);
+        return new Violation(severity, source, Optional.empty(), transactionViolationCode, processorModule, bag);
     }
 
     public static Violation create(Severity severity,
                                    Source source,
                                    String txItemId,
-                                   ViolationCode violationCode,
+                                   TransactionViolationCode transactionViolationCode,
                                    String processorModule,
                                    Map<String, Object> bag) {
-        return new Violation(severity, source, Optional.of(txItemId), violationCode, processorModule, bag);
+        return new Violation(severity, source, Optional.of(txItemId), transactionViolationCode, processorModule, bag);
     }
 
     public enum Severity {

diff --git a/...tations/LOB_ERPSourceVersionRelevant.java → ...e/annotations/LOBVersionSinkRelevant.java b/...tations/LOB_ERPSourceVersionRelevant.java → ...e/annotations/LOBVersionSinkRelevant.java
@@ -7,7 +7,7 @@
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
-public @interface LOB_ERPSourceVersionRelevant {
+public @interface LOBVersionSinkRelevant {
 
     String key() default "";
 

diff --git a/...ns/LOB_BlockchainSinkVersionRelevant.java → ...annotations/LOBVersionSourceRelevant.java b/...ns/LOB_BlockchainSinkVersionRelevant.java → ...annotations/LOBVersionSourceRelevant.java
@@ -7,7 +7,7 @@
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
-public @interface LOB_BlockchainSinkVersionRelevant {
+public @interface LOBVersionSourceRelevant {
 
     String key() default "";