From 8761c53b7ade3182569cf75797283960f6f25a59 Mon Sep 17 00:00:00 2001
From: Axel Granillo <axel@nofrixion.com>
Date: Fri, 29 Nov 2024 15:01:12 -0600
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20MOOV-3952:=20Add=20PayoutDocuments?=
 =?UTF-8?q?=20collection=20props?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../Enums/PayoutDocumentTypesEnum.cs          | 37 ++++++++++++
 .../Models/Payouts/Payout.cs                  |  6 ++
 .../Models/Payouts/PayoutCreate.cs            |  6 ++
 .../Models/Payouts/PayoutDocument.cs          | 34 +++++++++++
 .../Models/Payouts/PayoutDocumentCreate.cs    | 60 +++++++++++++++++++
 5 files changed, 143 insertions(+)
 create mode 100644 src/NoFrixion.MoneyMoov/Enums/PayoutDocumentTypesEnum.cs
 create mode 100644 src/NoFrixion.MoneyMoov/Models/Payouts/PayoutDocument.cs
 create mode 100644 src/NoFrixion.MoneyMoov/Models/Payouts/PayoutDocumentCreate.cs

diff --git a/src/NoFrixion.MoneyMoov/Enums/PayoutDocumentTypesEnum.cs b/src/NoFrixion.MoneyMoov/Enums/PayoutDocumentTypesEnum.cs
new file mode 100644
index 00000000..6593e207
--- /dev/null
+++ b/src/NoFrixion.MoneyMoov/Enums/PayoutDocumentTypesEnum.cs
@@ -0,0 +1,37 @@
+// -----------------------------------------------------------------------------
+//  Filename: PayoutDocumentTypesEnum.cs
+// 
+//  Description: Enum for the different types of payout documents.
+// 
+//  Author(s):
+//  Axel Granillo (axel@nofrixion.com)
+// 
+//  History:
+//  28 11 2024  Axel Granillo   Created, Remote, Mexico City, Mexico.
+// 
+//  License:
+//  MIT.
+// -----------------------------------------------------------------------------
+
+namespace NoFrixion.MoneyMoov.Enums;
+
+/// <summary>
+/// Enum for the different types of payout documents.
+/// </summary>
+public enum PayoutDocumentTypesEnum
+{
+    /// <summary>
+    /// Default general value.
+    /// </summary>
+    Other,
+    
+    /// <summary>
+    /// Invoice.
+    /// </summary>
+    Invoice,
+    
+    /// <summary>
+    /// Purchase order.
+    /// </summary>
+    PurchaseOrder,
+}
\ No newline at end of file
diff --git a/src/NoFrixion.MoneyMoov/Models/Payouts/Payout.cs b/src/NoFrixion.MoneyMoov/Models/Payouts/Payout.cs
index e7e064bd..13efee22 100755
--- a/src/NoFrixion.MoneyMoov/Models/Payouts/Payout.cs
+++ b/src/NoFrixion.MoneyMoov/Models/Payouts/Payout.cs
@@ -408,7 +408,13 @@ public Counterparty? DestinationAccount
     /// Collection of payrun invoices associated with the payout.
     /// Will be empty if the payout is not associated with a payrun.
     /// </summary>
+    [Obsolete("Please refer to the Documents collection.")]
     public List<PayrunInvoice>? PayrunInvoices { get; set; }
+    
+    /// <summary>
+    /// Documents associated with the payout.
+    /// </summary>
+    public List<PayoutDocument>? Documents { get; set; }
 
     public NoFrixionProblem Validate()
     {
diff --git a/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutCreate.cs b/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutCreate.cs
index a15d21dd..03176833 100755
--- a/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutCreate.cs
+++ b/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutCreate.cs
@@ -195,6 +195,12 @@ public Guid? BeneficiaryID
     /// payment, the default behaviour is to attempt SEPA-INST and fallback to SEPA-CT if rejected.
     /// </summary>
     public PaymentRailEnum PaymentRail { get; set; }
+    
+    /// <summary>
+    /// List of documents to attach to the payout. Optional.
+    /// Used for identifying or associating documents with the payout.
+    /// </summary>
+    public List<PayoutDocumentCreate>? Documents { get; set; }
 
     /// <summary>
     /// Places all the payout's properties into a dictionary.
diff --git a/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutDocument.cs b/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutDocument.cs
new file mode 100644
index 00000000..ee611490
--- /dev/null
+++ b/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutDocument.cs
@@ -0,0 +1,34 @@
+// -----------------------------------------------------------------------------
+//  Filename: PayoutDocument.cs
+// 
+//  Description: Contains details of a payout document.
+// 
+//  Author(s):
+//  Axel Granillo (axel@nofrixion.com)
+// 
+//  History:
+//  28 11 2024  Axel Granillo   Created, Remote, Mexico City, Mexico.
+// 
+//  License:
+//  MIT.
+// -----------------------------------------------------------------------------
+
+using NoFrixion.MoneyMoov.Enums;
+
+namespace NoFrixion.MoneyMoov.Models;
+
+/// <summary>
+/// Used for returning a payout document.
+/// </summary>
+public class PayoutDocument : PayoutDocumentCreate
+{
+    /// <summary>
+    /// Internal ID of the document.
+    /// </summary>
+    public Guid ID { get; set; }
+
+    /// <summary>
+    /// Date of insertion.
+    /// </summary>
+    public DateTimeOffset Inserted { get; set; }
+}
\ No newline at end of file
diff --git a/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutDocumentCreate.cs b/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutDocumentCreate.cs
new file mode 100644
index 00000000..42b64025
--- /dev/null
+++ b/src/NoFrixion.MoneyMoov/Models/Payouts/PayoutDocumentCreate.cs
@@ -0,0 +1,60 @@
+// -----------------------------------------------------------------------------
+//  Filename: PayoutDocumentCreate.cs
+// 
+//  Description: Contains details of a payout document.
+// 
+//  Author(s):
+//  Axel Granillo (axel@nofrixion.com)
+// 
+//  History:
+//  28 11 2024  Axel Granillo   Created, Remote, Mexico City, Mexico.
+// 
+//  License:
+//  MIT.
+// -----------------------------------------------------------------------------
+
+using System.ComponentModel.DataAnnotations;
+using NoFrixion.MoneyMoov.Enums;
+
+namespace NoFrixion.MoneyMoov.Models;
+
+/// <summary>
+/// Document associated with a payout.
+/// </summary>
+public class PayoutDocumentCreate
+{
+    /// <summary>
+    /// Type of the document.
+    /// </summary>
+    [Required]
+    public PayoutDocumentTypesEnum DocumentType { get; set; } = PayoutDocumentTypesEnum.Other;
+    
+    /// <summary>
+    /// Used to identify the document.
+    /// </summary>
+    [Required]
+    [MaxLength(128)]
+    public string? Title { get; set; }
+    
+    /// <summary>
+    /// Additional information about the document. Optional.
+    /// </summary>
+    [MaxLength(256)]
+    public string? Description { get; set; }
+
+    /// <summary>
+    /// Currency of the document, if applicable. Optional.
+    /// </summary>
+    public CurrencyTypeEnum? Currency { get; set; }
+
+    /// <summary>
+    /// Amount of the document, if applicable. Optional.
+    /// </summary>
+    public decimal? Amount { get; set; }
+    
+    /// <summary>
+    /// Allows to associate an external ID to the document. Optional.
+    /// </summary>
+    [MaxLength(128)]
+    public string? ExternalID { get; set; }
+}
\ No newline at end of file