[E-Document Core] - Extending the Core app with payments #5

AdeleStankeviciute · 2025-01-06T08:06:54Z

Implementation

The new functionality improves E-Document feature by introducing payment tracking. Users can now track both Incoming and Outgoing payments, with ability to monitor payment statuses by showing whether they are fully paid, partially paid or unpaid.

New field "Payment Integration" was added to E-Document Services page together with "Calculate Payment VAT" boolean. For the "Payment Integration" a user can set a particular payment handler/service for sending and receiving payments. By enabling "Calculate Payment VAT" boolean, payment amount is split into Base Amount and VAT Amount.

Additionally, the "Paid Amount" and "Payment Status" fields were added on E-Document page. On "Paid Amount" drilldown, user can access "E-Documents Payments" page, where payment date, paid amount without VAT and VAT amount are displayed, together with payment status and whether payment is incoming or outgoing. The payment date and amount fields can be edited manually, while the other fields are automatically populated by the system.

New actions "Receive Payments" and "Send Payment" have also been added under the "Actions" menu on the E-Document page. "Receive Payments" actions allows user to receive payments via service and all data related to payment appears on "E-Document Payment" page, as well as updated payment status on E-Document. Meanwhile, "Send Payment" action can be used to filter unsent payments based on status and direction. The system adds E-Document and its values, identifies the right service for sending and updates the payment status of E-Document. This occurs even when the payment is created manually, regardless of whether it has been sent yet.

Additional fields were added on "E-Documents Service" page, related to background job: "Auto Sync Payments", "Sync Start Time" and "Minutes between runs". The job queue is created when "Auto Sync Payments" boolean is enabled and same background job runs both sending and receiving actions.

Default integration is a placeholder and does not actually send or receive payments. New integrations can be added by extending enum "Payment Integration" and implementing interface IDocumentPaymentHandler.

MS PR: microsoft#27972

tinestaric

Great looking PR! I still have a few questions around the management CU pattern, but overall very nice, great work!

Apps/W1/EDocument/app/src/Document/EDocument.Page.al

Apps/W1/EDocument/app/src/Helpers/EDocumentErrorHelper.Codeunit.al

tinestaric · 2025-01-08T07:51:18Z

Apps/W1/EDocument/app/src/Helpers/EDocumentErrorHelper.Codeunit.al

+    begin
+        ErrorMessage.SetRange("Context Record ID", EDocument.RecordId());
+        ErrorMessage.SetRange("Table Number", Database::"E-Document Payment");
+        ErrorMessage.DeleteAll();


Add explicit RunTrigger

tinestaric · 2025-01-08T07:52:12Z

Apps/W1/EDocument/app/src/Integration/Actions/Implementations/EmptyPaymentHandler.Codeunit.al

+
+/// <summary>
+/// This codeunit is used to implement the "Document Payment Handler" interface. It is used to provide a default implementation for the "Action Invoker" interface.
+/// </summary>


Action Invoker?

tinestaric · 2025-01-08T07:53:29Z

Apps/W1/EDocument/app/src/Integration/Actions/Implementations/EmptyPaymentHandler.Codeunit.al

+    InherentPermissions = X;
+
+    procedure Send(var EDocument: Record "E-Document"; var EDocumentService: Record "E-Document Service"; PaymentContext: Codeunit PaymentContext)
+    begin


nit, preference: I prefer to see a // Do nothing comment within these placeholder implementations as it makes it clear this is intentionally empty.

Apps/W1/EDocument/app/src/Payments/EDocumentPayments.Page.al

tinestaric · 2025-01-08T08:22:39Z

Apps/W1/EDocument/app/src/Payments/EDocumentPayment.Table.al

+
+    trigger OnInsert()
+    begin
+        if Rec.Status = Rec.Status::" " then


Why even add the Empty status? Why not make Created the first one? or set the InitValue to Created?

Apps/W1/EDocument/app/src/Payments/EDocumentPayment.Table.al

tinestaric · 2025-01-08T08:25:21Z

Apps/W1/EDocument/app/src/Integration/Interfaces/IDocumentPaymentHandler.Interface.al

+using System.Utilities;
+
+/// <summary>
+/// Interface for sending and receiving paymnet information for E-Documents using E-Document service


Typo: ..payment..

Apps/W1/EDocument/app/src/Integration/Payments/PaymentIntegrationManagement.Codeunit.al

GMatuleviciute · 2025-01-08T12:57:21Z

Apps/W1/EDocument/app/src/Document/EDocument.Table.al

+            FieldClass = FlowField;
+            CalcFormula = sum("E-Document Payment".Amount where("E-Document Entry No." = field("Entry No"), Direction = field("Payment Direction Filter")));
+        }
+        field(33; "Payment Direction Filter"; Enum "E-Document Direction")


I do not think we need to have Payment Direction Filter in the E-Document table. Related payments can be filtered based on Entry No. (I assume the document should not change direction :D ). Maybe we could save the direction only on E-Document Payment table.

Apps/W1/EDocument/app/src/Helpers/EDocumentErrorHelper.Codeunit.al

Apps/W1/EDocument/app/src/Payments/EDocumentPayment.Table.al

GMatuleviciute · 2025-01-09T07:02:29Z

Apps/W1/EDocument/app/src/Payments/EDocumentPaymentProgress.Enum.al

+    {
+        Caption = 'Partially Paid';
+    }
+    value(3; "Paid In Full")


nit: I would call it simple Paid

GMatuleviciute · 2025-01-09T07:09:18Z

Apps/W1/EDocument/app/src/Service/EDocumentService.Table.al

+            NotBlank = true;
+            InitValue = 0T;
+        }
+        field(33; "Payment Sync Min between runs"; Integer)


Payment Sync Min Between Runs ?

tinestaric · 2025-01-09T09:41:16Z

Apps/W1/EDocument/app/src/Payments/EDocumentPayment.Table.al

@@ -43,21 +52,31 @@ table 6101 "E-Document Payment"
        {
            Caption = 'VAT Base';
            DecimalPlaces = 2;
+            Editable = false;
+            ToolTip = 'Specifies the value of the VAT Base field.';


Let's add more meaningful tooltips.

nerkel91 · 2025-01-21T11:47:53Z

Implementation

The new functionality improves E-Document feature by introducing payment tracking. Users can now track both Incoming and Outgoing payments, with ability to monitor payment statuses by showing whether they are fully paid, partially paid or unpaid.

New field "Payment Integration" was added to E-Document Services page together with "Calculate Payment VAT" boolean. For the "Payment Integration" a user can set a particular payment handler/service for sending and receiving payments. By enabling "Calculate Payment VAT" boolean, payment amount is split into Base Amount and VAT Amount.
Additionally, the "Paid Amount" and "Payment Status" fields were added on E-Document page. On "Paid Amount" drilldown, user can access "E-Documents Payments" page, where payment date, paid amount without VAT and VAT amount are displayed, together with payment status and whether payment is incoming or outgoing. The payment date and amount fields can be edited manually, while the other fields are automatically populated by the system.
New actions "Receive Payments" and "Send Payment" have also been added under the "Actions" menu on the E-Document page. "Receive Payments" actions allows user to receive payments via service and all data related to payment appears on "E-Document Payment" page, as well as updated payment status on E-Document. Meanwhile, "Send Payment" action can be used to filter unsent payments based on status and direction. The system adds E-Document and its values, identifies the right service for sending and updates the payment status of E-Document. This occurs even when the payment is created manually, regardless of whether it has been sent yet.
Additional fields were added on "E-Documents Service" page, related to background job: "Auto Sync Payments", "Sync Start Time" and "Minutes between runs". The job queue is created when "Auto Sync Payments" boolean is enabled and same background job runs both sending and receiving actions.

Default integration is a placeholder and does not actually send or receive payments. New integrations can be added by extending enum "Payment Integration" and implementing interface IDocumentPaymentHandler.

Apps/W1/EDocument/app/src/Document/EDocument.Page.al

GMatuleviciute · 2025-01-21T13:07:58Z

Apps/W1/EDocument/app/src/Document/EDocument.Page.al

+            if Rec."Paid Amount" < Rec."Amount Incl. VAT" then
+                this.PaymentStatus := this.PaymentStatus::"Partially Paid"
+            else
+                this.PaymentStatus := this.PaymentStatus::Paid


this.PaymentStatus := this.PaymentStatus::Paid; ( ; is missing)

GMatuleviciute · 2025-01-21T13:12:45Z

Apps/W1/EDocument/app/src/Integration/Payments/GetPaymentDetails.Codeunit.al

+// ------------------------------------------------------------------------------------------------
+namespace Microsoft.eServices.EDocument.Integration.Payments;
+
+


One empty line should be between namespace and using

Apps/W1/EDocument/app/src/Integration/Payments/PaymentContext.Codeunit.al

GMatuleviciute · 2025-01-21T13:23:48Z

Apps/W1/EDocument/app/src/Integration/Payments/PaymentContext.Codeunit.al

+        PaymentStatus: Enum "Payment Status";
+        Date: Date;
+        Amount: Decimal;
+


Remove the empty line before the global variables and object closing bracket

GMatuleviciute · 2025-01-21T13:26:20Z

Apps/W1/EDocument/app/src/Integration/Payments/PaymentIntegrationManagement.Codeunit.al

+        Payment.Date := PaymentContext.GetDate();
+        Payment.Validate(Amount, PaymentContext.GetAmount());
+        Payment.Status := PaymentContext.GetPaymentStatus();
+        Payment.Insert();


Add explicit of RunTrigger

Apps/W1/EDocument/app/src/Integration/Payments/GetPaymentDetails.Codeunit.al

Apps/W1/EDocument/app/src/Integration/Payments/ReceivePayments.Codeunit.al

…ppExtensions into dev/asm/86422

extending the Core app with payments

d89a2a0

AdeleStankeviciute changed the title ~~extending the Core app with payments~~ [E-Document Core] - Extending the Core app with payments Jan 6, 2025

GMatuleviciute requested review from tinestaric and GMatuleviciute January 7, 2025 16:05

tinestaric requested changes Jan 8, 2025

View reviewed changes

GMatuleviciute requested changes Jan 9, 2025

View reviewed changes

remove direction filter, add small fixes

be90cbf

tinestaric requested changes Jan 9, 2025

View reviewed changes

add automated tests

9672d29

GMatuleviciute requested changes Jan 21, 2025

View reviewed changes

AdeleStankeviciute added 2 commits January 21, 2025 15:44

fixes

8f89380

fixes

0768d7d

GMatuleviciute requested changes Jan 22, 2025

View reviewed changes

Apps/W1/EDocument/app/src/Integration/Payments/GetPaymentDetails.Codeunit.al Show resolved Hide resolved

Apps/W1/EDocument/app/src/Integration/Payments/ReceivePayments.Codeunit.al Show resolved Hide resolved

AdeleStankeviciute and others added 3 commits January 22, 2025 11:08

modify permission sets

9809c08

Format fixes

ac0892d

Merge branch 'dev/asm/86422' of https://github.com/GMatuleviciute/ALA…

185f95a

…ppExtensions into dev/asm/86422

GMatuleviciute added the InProgress label Jan 22, 2025

AdeleStankeviciute and others added 3 commits January 22, 2025 15:49

change automated tests

89e251c

Merge branch 'dev/asm/86422' of https://github.com/GMatuleviciute/ALA…

aee7aea

…ppExtensions into dev/asm/86422

Removed workspace

d6774b8

GMatuleviciute added PublishedToMS and removed InProgress labels Jan 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[E-Document Core] - Extending the Core app with payments #5

[E-Document Core] - Extending the Core app with payments #5

AdeleStankeviciute commented Jan 6, 2025 •

edited by tinestaric

Loading

tinestaric left a comment

tinestaric Jan 8, 2025

tinestaric Jan 8, 2025

tinestaric Jan 8, 2025

tinestaric Jan 8, 2025

tinestaric Jan 8, 2025

GMatuleviciute Jan 8, 2025

GMatuleviciute Jan 9, 2025

GMatuleviciute Jan 9, 2025

tinestaric Jan 9, 2025

nerkel91 commented Jan 21, 2025

GMatuleviciute Jan 21, 2025

GMatuleviciute Jan 21, 2025

GMatuleviciute Jan 21, 2025

GMatuleviciute Jan 21, 2025

		// ------------------------------------------------------------------------------------------------
		namespace Microsoft.eServices.EDocument.Integration.Payments;

[E-Document Core] - Extending the Core app with payments #5

Are you sure you want to change the base?

[E-Document Core] - Extending the Core app with payments #5

Conversation

AdeleStankeviciute commented Jan 6, 2025 • edited by tinestaric Loading

tinestaric left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nerkel91 commented Jan 21, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdeleStankeviciute commented Jan 6, 2025 •

edited by tinestaric

Loading