Merge pull request #157 from FacturAPI/feat/payment-invoice-relationships

Author: javorosas

website/openapi_v2.en.yaml

@@ -8564,11 +8564,24 @@ components:
           description: Documents related to the invoice.
           items:
             $ref: "#/components/schemas/RelatedDocument"
-        payment_related_ids: 
+        received_payment_ids:
           type: array
           items: 
             type: string
-          description: If this invoice has a payment method PPD and type I, this field will have the related payment id of this invoice.
+          description: |
+            On invoices with type I (Income) and payment method PPD, this field lists the
+            object IDs of the payment invoices whose related documents array includes the UUID
+            of this invoice. This field is filled in by Facturapi the moment the payment invoice
+            (type P) is created or imported, as long as it belongs to the same organization.
+          default: []
+        target_invoice_ids:
+          type: array
+          items:
+            type: string
+          description: |
+            On invoices with type P (Payment), this array lists the object IDs of the invoices listed in
+            the related documents array. This field is filled in by Facturapi as long as the
+            related invoice is also registered in Facturapi and belongs to the same organization.
           default: []
         currency:
           type: string

website/openapi_v2.yaml

@@ -8455,6 +8455,25 @@ components:
           description: Documentos relacionados con la factura.
           items:
             $ref: "#/components/schemas/RelatedDocument"
+        received_payment_ids:
+          type: array
+          items:
+            type: string
+          description: |
+            En facturas con tipo I (Ingreso) y método de pago PPD, este campo lista los
+            IDs de los comprobantes de pago cuyo arreglo de documentos relacionados incluye el UUID
+            de esta factura. Este campo es llenado por Facturapi en el momento en que se crea o importa
+            el comprobante de pago (tipo P), siempre y cuando pertenezca a la misma organización.
+          default: []
+        target_invoice_ids:
+          type: array
+          items:
+            type: string
+          description: |
+            En facturas con tipo P (Pago), este arreglo lista los IDs de los comprobantes de ingreso
+            listados en el arreglo de documentos relacionados. Este campo es llenado por Facturapi siempre
+            y cuando el comprobante relacionado también esté registrado en Facturapi y pertenezca a la misma organización.
+          default: []
         currency:
           type: string
           example: MXN
@@ -8485,12 +8504,6 @@ components:
             $ref: "#/components/schemas/NamespaceProperties"
         stamp:
           $ref: "#/components/schemas/Stamp"
-        payment_related_ids:
-          type: array
-          items:
-            type: string
-          description: Si esta factura tiene un método de pago PPD y es de tipo I, este campo contendrá los id de pagos relacionados a esta factura.
-          default: []
     InvoiceDraftProperties:
       type: object
       properties: