feat: add payment information to schema

w3c-ccg · Oct 20, 2023 · 02af96d · 02af96d
1 parent 2c8fa71
commit 02af96d
Showing 1 changed file with 140 additions and 3 deletions.
diff --git a/docs/openapi/components/schemas/credentials/EInvoiceCredential.yml b/docs/openapi/components/schemas/credentials/EInvoiceCredential.yml
@@ -199,6 +199,8 @@ properties:
       - type
       - relatedDocuments
       - buyer
+      - shipment
+      - payment
     type: object
     properties:
       type:
@@ -242,6 +244,7 @@ properties:
                 - PackingList
                 - BillOfLading
                 - CertificationOfOrigin
+                - LetterOfCredit
       buyer:
         title: Buyer
         description: Importer of record. Party placing the order or paying the invoice.
@@ -385,6 +388,10 @@ properties:
                 The offer price of a product, or of a price component when attached to
                 PriceSpecification and its subtypes.
               type: number
+            count:
+              title: Count
+              description: The number of products included in the line item
+              type: number
             priceCurrency:
               title: Price Currency
               description: >-
@@ -403,8 +410,6 @@ properties:
                 - kilogram
                 - tonne
                 - pounds
-
-
       shipment:
         title: Shipment
         description: Details about the shipment being made
@@ -434,6 +439,14 @@ properties:
             title: Shipment Method
             description: The method in which the goods in the invoice are being shipped
             type: string
+          freightCost: 
+            title: Freight Cost
+            description: Included cost of freight
+            type: number
+          freightCostCurrency: 
+            title: Frieght Cost Currency
+            description: Currency in which frieght cost is calculated
+            type: string
           shipTo:
             title: Ship To (optional)
             description: The organization of the party receiving the products (consignee) and their address if different from the buyer
@@ -542,7 +555,104 @@ properties:
             minItems: 0
             maxItems: 1
 
-
+      payment:
+        title: Payment
+        description: Information about payment
+        type: object
+        properties:
+          type:
+            type: array
+            items:
+              type: object
+              properties:
+                type:
+                  type: array
+                  readOnly: true
+                  const:
+                    - Payment
+                  default:
+                    - Payment
+                  items:
+                    type: string
+                    enum:
+                      - Payment
+          termsOfPayment: 
+            title: Terms of Payment
+            description: Terms, conditions, and currency of settlement, as agreed upon by the vendor and purchaser per the pro forma invoice, customer purchase order, and/or the letter of credit.
+            type: string
+          payTo: 
+            title: Pay To
+            description: Information about the account in which to deposit the funds
+            type: string
+          currencyOfSettlement: 
+            title: Terms of Settlement
+            description: Currency agreed upon between seller and buyer as payment.
+            type: string
+          totalDue:
+            title: Price
+            description: The total sum of the invoice due
+            type: number
+          invoiceSubtotal:
+            title: Invoice Subtotal
+            description: The subtotal of line items.
+            type: object
+            additionalProperties: false
+            required:
+              - type
+            properties:
+              type:
+                type: array
+                readOnly: true
+                const:
+                  - PriceSpecification
+                default:
+                  - PriceSpecification
+                items:
+                  type: string
+                  enum:
+                    - PriceSpecification
+              price:
+                title: Price
+                description: >-
+                  The offer price of a product, or of a price component when attached to
+                  PriceSpecification and its subtypes.
+                type: number
+              priceCurrency:
+                title: Price Currency
+                description: >-
+                  The currency of the price, or a price component when attached to
+                  PriceSpecification and its subtypes.
+                type: string
+              discounts:
+                title: Discounts (optional)
+                description: Reductions in price applied to the subtotal
+                type: array
+                items:
+                  type: object
+                  properties:
+                    type:
+                      type: array
+                      readOnly: true
+                      const:
+                        - Discount
+                      default:
+                        - Discount
+                      items:
+                        type: string
+                        enum:
+                          - Discount
+                    appliedTo:
+                      title: Applied To
+                      description: Defines if the discount is applied to a specific product or the subtotal
+                      type: string
+                    discount:
+                      title: Discount
+                      description: The percent or currency amount the above is reduced by
+                      type: string
+                    reason:
+                      title: Reason
+                      description: The reason the discount was applied
+                      type: string
   proof:
     title: proof
     description: A JSON Web Signature proof for a credential as defined by the VC data model 
@@ -668,6 +778,7 @@ example: |-
           "description": "Round Rebar used for Construction",
           "productIdentifier": "rn19082-a",
           "price": 1000,
+          "count": 5,
           "priceCurrency": "USD",
           "netWeight": 1,
           "netWeightUnit": "tonne"
@@ -679,6 +790,8 @@ example: |-
         ],
         "termsOfDelivery": "full payment before shipment",
         "shipmentMethod": "Tailer No. 53103",
+        "freightCost": 200,
+        "freightCostCurrency": "USD",
         "shipTo": [
           {
             "type": [
@@ -703,6 +816,30 @@ example: |-
             }
           }
         ]
+      },
+      "payment": {
+        "type": [
+          "Payment"
+        ],
+        "termsOfPayment": "Payment made to bank account within 30 days of invoice",
+        "payTo": "Example Bank Acct. 1234567 Routing Number 123456789",
+        "currencyOfSettlement": "USD",
+        "totalDue": 4700,
+        "invoiceSubtotal": {
+          "type": [
+            "PriceSpecification"
+          ],
+          "price": 5000,
+          "priceCurrency": "USD",
+          "discounts": [
+            {
+              "type": ["Discount"],
+              "appliedTo": "subtotal",
+              "discount": "10%",
+              "reason": "First time customer"
+            }
+          ]
+        }
       }
     },
     "credentialSchema": {