WE BUILD eInvoice Attestation

Claims (22)

SD-JWT VC Type Metadata (IETF draft-ietf-oauth-sd-jwt-vc)

{
  "vct": "eu.we-build:einvoice:1",
  "name": "WE BUILD eInvoice Attestation",
  "description": "JSON Schema for the SD-JWT VC claims set of the eInvoice attestation (vct: eu.we-build:einvoice:1)",
  "display": [
    {
      "locale": "en-US",
      "name": "WE BUILD eInvoice Attestation",
      "description": "JSON Schema for the SD-JWT VC claims set of the eInvoice attestation (vct: eu.we-build:einvoice:1)"
    }
  ],
  "claims": [
    {
      "path": [
        "attestation_legal_category"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "Attestation Legal Category"
        }
      ],
      "description": "Legal category of the attestation. For this rulebook profile the exact value SHALL be `non-qualified-EAA`. Section 2.1.",
      "mandatory": true
    },
    {
      "path": [
        "invoiceNumber"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "InvoiceNumber"
        }
      ],
      "description": "EN 16931 BT-1. Invoice identifier, unique for the Supplier within the duplicate-detection window (IR-EI-04). Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "issueDate"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "IssueDate"
        }
      ],
      "description": "EN 16931 BT-2. Invoice issue date (RFC 3339 full-date). Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "sellerRegistrationName"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "SellerRegistrationName"
        }
      ],
      "description": "EN 16931 BT-27. Registered legal name of the Supplier. Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "BuyerElectronicAddress"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "BuyerElectronicAddress"
        }
      ],
      "description": "EN 16931 BT-49. Address/endpoint identifier for delivery/receipt handling. Section 2.3."
    },
    {
      "path": [
        "taxSubtotal"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "TaxSubtotal"
        }
      ],
      "description": "EN 16931 BG-23. VAT breakdown, one entry per tax category/rate. Section 2.3/2.4."
    },
    {
      "path": [
        "sellerLegalRegistrationIdentifier"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "SellerLegalRegistrationIdentifier"
        }
      ],
      "description": "EN 16931 BT-30. Reference to the Supplier's Legal Person identity (EUCC/LPID). Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "buyerVatIdentifier"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "BuyerVatIdentifier"
        }
      ],
      "description": "EN 16931 BT-48. VAT/tax registration identifier of the Buyer. Section 2.3."
    },
    {
      "path": [
        "buyerCountry"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "BuyerCountry"
        }
      ],
      "description": "EN 16931 BT-55. ISO 3166-1 alpha-2 country code of the Buyer. Section 2.3."
    },
    {
      "path": [
        "invoiceTotalVatAmount"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "InvoiceTotalVatAmount"
        }
      ],
      "description": "EN 16931 BT-110. Total VAT amount for this invoice; SHALL equal the sum of taxSubtotal.taxAmount when taxSubtotal is present (IR-EI-07). Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "InvoiceCurrencyCode"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "InvoiceCurrencyCode"
        }
      ],
      "description": "EN 16931 BT-5. ISO 4217 invoice currency code. Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "paymentInstructions"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "PaymentInstructions"
        }
      ],
      "description": "EN 16931 BG-16. Payment-related information. Contains sensitive payment data; issuer MUST make selectively disclosable. Section 2.3/2.4/3.2.",
      "sd": "always"
    },
    {
      "path": [
        "precedingInvoiceReference"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "PrecedingInvoiceReference"
        }
      ],
      "description": "EN 16931 BT-25. Identifier of the original or preceding invoice. SHALL be present when invoiceLifecycleStatus is corrected, cancelled or credited; MAY be omitted when the lifecycle status is active or omitted. Section 2.4 and IR-EI-09."
    },
    {
      "path": [
        "invoicePayloadHash"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "InvoicePayloadHash"
        }
      ],
      "description": "Hash of the canonicalized invoice payload; binds the attestation to the external EN 16931 / Peppol BIS invoice (IR-EI-03). Section 2.2. NOTE: canonicalization method and hash algorithm are OPEN pending WP4 confirmation; sha256 assumed here.",
      "mandatory": true
    },
    {
      "path": [
        "invoiceFormat"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "InvoiceFormat"
        }
      ],
      "description": "Identifier of the invoice representation/profile used for the payload. Code list, Section 2.8."
    },
    {
      "path": [
        "sellerVatIdentifier"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "SellerVatIdentifier"
        }
      ],
      "description": "EN 16931 BT-31. VAT/tax registration identifier of the Supplier. Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "sellerCountry"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "SellerCountry"
        }
      ],
      "description": "EN 16931 BT-40. ISO 3166-1 alpha-2 country code of the Supplier. Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "amountDueForPayment"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "AmountDueForPayment"
        }
      ],
      "description": "EN 16931 BT-115. Total payable amount. Section 2.2.",
      "mandatory": true
    },
    {
      "path": [
        "cryptographically_bound_to"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "Cryptographically Bound To"
        }
      ],
      "description": "vct of the Supplier's EBWOID attestation on the same Wallet Unit to which this attestation is bound. RECOMMENDED. Section 2.6 / Chapter 4."
    },
    {
      "path": [
        "buyerLegalRegistrationIdentifier"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "BuyerLegalRegistrationIdentifier"
        }
      ],
      "description": "EN 16931 BT-47. Reference to the Buyer's Legal Person identity (EUCC/LPID). Section 2.3."
    },
    {
      "path": [
        "evidenceReferences"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "EvidenceReferences"
        }
      ],
      "description": "References to supporting evidence items (e.g. purchase order, delivery note). Section 2.3/2.4."
    },
    {
      "path": [
        "invoiceLifecycleStatus"
      ],
      "display": [
        {
          "locale": "en-US",
          "label": "InvoiceLifecycleStatus"
        }
      ],
      "description": "Business lifecycle status for corrections, cancellations and credit notes. If omitted, the lifecycle status SHALL be interpreted as `active`. Distinct from the registered `status` metadata claim used for Token Status List revocation. Sections 2.3, 2.8 and IR-EI-09."
    }
  ]
}