@endevops/peppol-schema 0.1.0-beta.4 → 0.1.0-beta.5

package/src/schemas/peppol-billing-base-schema.ts

@@ -0,0 +1,366 @@
+import { Effect, Schema } from 'effect';
+
+import { DEFAULT_CUSTOMIZATION_ID } from '#/schemas/fields/default-customization-id';
+import { DEFAULT_PROFILE_ID } from '#/schemas/fields/default-profile-id';
+import { PeppolAdditionalDocumentReference } from '#/schemas/fields/peppol-additional-document-reference-schema';
+import { peppolAllowanceChargeSchema } from '#/schemas/fields/peppol-allowance-charge-schema';
+import { PeppolBillingReference } from '#/schemas/fields/peppol-billing-reference-schema';
+import { PeppolDelivery } from '#/schemas/fields/peppol-delivery-schema';
+import { PeppolInvoicePeriod } from '#/schemas/fields/peppol-invoice-period-schema';
+import { PeppolLegalMonetaryTotal } from '#/schemas/fields/peppol-legal-monetary-total-schema';
+import { PeppolOrderReference } from '#/schemas/fields/peppol-order-reference-schema';
+import { PeppolPartySchema } from '#/schemas/fields/peppol-party-base-schema';
+import { PeppolPayeeParty } from '#/schemas/fields/peppol-payee-party-schema';
+import { PeppolPaymentMeans } from '#/schemas/fields/peppol-payment-means-schema';
+import { PeppolPaymentTerms } from '#/schemas/fields/peppol-payment-terms-schema';
+import { PeppolTaxRepresentative } from '#/schemas/fields/peppol-tax-representative-schema';
+import { PeppolTaxTotalsBase } from '#/schemas/fields/peppol-tax-totals-base-schema';
+import { PeppolIsoDateString } from '#/schemas/peppol-iso-date-string';
+import { opaque } from '#/schemas/utils/opaque';
+import { currencyCodeSchema } from '#/schemas/values/currency-code-schema';
+
+export class PeppolContractDocumentReference extends opaque<PeppolContractDocumentReference>()(
+  Schema.Struct({
+    /**
+     * @description An identifier of a referenced contract.
+     *
+     * @example
+     *   `123Contractref`;
+     *
+     * @summary Contract reference
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String,
+  })
+) {}
+
+export class PeppolOriginatorDocumentReference extends opaque<PeppolOriginatorDocumentReference>()(
+  Schema.Struct({
+    /**
+     * @description The identification of the call for tender or lot the invoice relates to.
+     *
+     * @example
+     *   `PPID-123`;
+     *
+     * @summary Tender or lot reference
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String,
+  })
+) {}
+
+export class PeppolReceiptDocumentReference extends opaque<PeppolReceiptDocumentReference>()(
+  Schema.Struct({
+    /**
+     * @description An identifier of a referenced receiving advice.
+     *
+     * @example
+     *   `rec98`;
+     *
+     * @summary Receiving advice reference
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String,
+  })
+) {}
+
+export class PeppolDespatchDocumentReference extends opaque<PeppolDespatchDocumentReference>()(
+  Schema.Struct({
+    /**
+     * @description An identifier of a referenced despatch advice.
+     *
+     * @example
+     *   `desp98`;
+     *
+     * @summary Despatch advice reference
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String,
+  })
+) {}
+
+/**
+ * @description Base schema for a billing document.
+ *
+ * @see {@link creditNoteSchema} - the credit note schema
+ * @see {@link invoiceSchema} - the invoice schema
+ */
+export class PeppolBillingBase extends opaque<PeppolBillingBase>()(
+  Schema.Struct({
+    /**
+     * @description An identification of the specification containing the total set of rules regarding semantic content, cardinalities, and business rules to which
+     * the data contained in the intance document conforms.
+     *
+     * @default `urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0`
+     *
+     * @summary Specification identifier
+     *
+     * @cardinality 1..1
+     *
+     * @name `cbc:CustomizationID`
+     */
+    customizationId: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed(DEFAULT_CUSTOMIZATION_ID))).check(
+      Schema.isStartsWith('urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0', {
+        message:
+          "PEPPOL-EN16931-R004: Specification identifier MUST have the value 'urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0'.",
+      })
+    ),
+    /**
+     * @description Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.
+     *
+     * @default `urn:fdc:peppol.eu:2017:poacc:billing:01:1.0`
+     *
+     * @summary Business process type
+     *
+     * @name `cbc:ProfileID`
+     */
+    profileId: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed(DEFAULT_PROFILE_ID))).check(
+      Schema.isPattern(/^urn:fdc:peppol.eu:2017:poacc:billing:(\d{2}):1\.0$/, {
+        message:
+          "PEPPOL-EN16931-R007: Business process MUST be in the format 'urn:fdc:peppol.eu:2017:poacc:billing:NN:1.0' where NN indicates the process number.",
+      })
+    ),
+    /**
+     * @description A using identification of the Invoice. The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify
+     * the Invoice within the business context, time-frame, operating systems and records of the Seller. No identification scheme is to be used.
+     *
+     * @example
+     *   33445566;
+     *
+     * @summary Invoice number
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String,
+    /**
+     * @description The date when the invoice was issued.
+     *
+     * @example
+     *   `2017-11-01`;
+     *
+     * @summary Invoice issue date
+     *
+     * @format `YYYY-MM-DD`
+     *
+     * @name `cbc:IssueDate`
+     */
+    issueDate: PeppolIsoDateString,
+    /**
+     * @description Invoice note A textual note that gives unstructured information that is relevant to the Credit Note as a whole.
+     *
+     * @example
+     *   Please note our new phone number 33 44 55 66
+     *
+     * @name `cbc:Note`
+     */
+    note: Schema.optional(Schema.String),
+    /**
+     * @description The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date
+     * of issue of the invoice, according to the VAT directive.This element is required if the Value added tax point date is different from the
+     * Invoice issue date.
+     *
+     * @example
+     *   2017 - 11 - 01;
+     *
+     * @summary Value added tax point date
+     *
+     * @name `cbc:TaxPointDate`
+     */
+    taxPointDate: Schema.optional(PeppolIsoDateString),
+    /**
+     * @description The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency. Only one currency shall be used in
+     * the Invoice, except for the VAT accounting currency code (BT-6) and the invoice total VAT amount in accounting currency (BT-111).
+     *
+     * @example
+     *   EUR;
+     *
+     * @summary Invoice currency code
+     *
+     * @name `cbc:DocumentCurrencyCode`
+     */
+    documentCurrencyCode: currencyCodeSchema,
+    /**
+     * @description The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller. Shall be used in combination
+     * with the Invoice total VAT amount in accounting currency (BT-111), when the VAT accounting currency code differs from the Invoice currency
+     * code.
+     *
+     * @example
+     *   SEK;
+     *
+     * @summary VAT accounting currency code
+     *
+     * @name `cbc:TaxCurrencyCode`
+     */
+    taxCurrencyCode: Schema.optional(currencyCodeSchema),
+    /**
+     * @description A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
+     *
+     * @example
+     *   `4217:2323:2323`;
+     *
+     * @summary Buyer accounting reference
+     *
+     * @name `cbc:AccountingCost`
+     */
+    accountingCost: Schema.optional(Schema.String),
+    /**
+     * @description An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference
+     * (BT-13).
+     *
+     * @example
+     *   `abs1234`;
+     *
+     * @summary Buyer reference
+     *
+     * @name `cbc:BuyerReference`
+     */
+    buyerReference: Schema.optional(Schema.String),
+    /**
+     * @description A group of business terms providing information on the invoice period. Also called delivery period. If the group is used, the invoiceing period
+     * start date and/or end date must be used.
+     *
+     * @summary DELIVERY OR INVOICE PERIOD
+     *
+     * @name `cac:InvoicePeriod`
+     */
+    invoicePeriod: Schema.optional(PeppolInvoicePeriod),
+    /**
+     * @summary ORDER AND SALES ORDER REFERENCE
+     *
+     * @name `cac:OrderReference`
+     */
+    orderReference: Schema.optional(PeppolOrderReference),
+    /**
+     * @summary PRECEDING INVOICE REFERENCE (0..n)
+     *
+     * @name `cac:BillingReference`
+     */
+    billingReferences: Schema.optional(Schema.Array(PeppolBillingReference)),
+    /**
+     * @summary DESPATCH ADVICE REFERENCE
+     *
+     * @name `cac:DespatchDocumentReference`
+     */
+    despatchDocumentReference: Schema.optional(PeppolDespatchDocumentReference),
+    /**
+     * @summary RECEIPT ADVICE REFERENCE
+     *
+     * @name `cac:ReceiptDocumentReference`
+     */
+    receiptDocumentReference: Schema.optional(PeppolReceiptDocumentReference),
+    /**
+     * @summary TENDER OR LOT REFERENCE
+     *
+     * @name `cac:OriginatorDocumentReference`
+     */
+    originatorDocumentReference: Schema.optional(PeppolOriginatorDocumentReference),
+
+    /**
+     * @summary CONTRACT REFERENCE
+     *
+     * @name `cac:ContractDocumentReference`
+     */
+    contractDocumentReference: Schema.optional(PeppolContractDocumentReference),
+
+    /**
+     * @description A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. The
+     * additional supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external
+     * document (referenced by a URL) or as an embedded document, Base64 encoded (such as a time report).
+     *
+     * @summary ADDITIONAL SUPPORTING DOCUMENTS
+     *
+     * @name `cac:AdditionalDocumentReference`
+     */
+    additionalDocumentReferences: Schema.optional(Schema.Array(PeppolAdditionalDocumentReference)),
+
+    /**
+     * @description A group of business terms providing information about the seller.
+     *
+     * @summary SELLER
+     *
+     * @name `cac:AccountingSupplierParty`
+     */
+    accountingSupplierParty: PeppolPartySchema,
+
+    /**
+     * @description A group of business terms providing information about the Buyer.
+     *
+     * @summary BUYER
+     *
+     * @name `cac:AccountingCustomerParty`
+     */
+    accountingCustomerParty: PeppolPartySchema,
+
+    /**
+     * @description A group of business terms providing information about the Payee, i.e. the role that received the payment. Shall be used wwhen the payee is
+     * different from the seller.
+     *
+     * @summary PAYEE
+     *
+     * @name cac:PayeeParty
+     */
+    payeeParty: Schema.optional(PeppolPayeeParty),
+
+    /**
+     * @description SELLER TAX REPRESENTATIVE PARTY.
+     *
+     * @name cac:TaxRepresentativeParty
+     */
+    taxRepresentativeParty: Schema.optional(PeppolTaxRepresentative),
+
+    /**
+     * @description DELIVERY INFORMATION.
+     *
+     * @name cac:Delivery
+     */
+    delivery: Schema.optional(PeppolDelivery),
+
+    /**
+     * @summary PAYMENT INSTRUCTIONS
+     * @summary A group of business terms providing information about the payment.
+     *
+     * @name cac:PaymentMeans
+     */
+    paymentMeans: Schema.optional(Schema.Array(PeppolPaymentMeans)),
+
+    /**
+     * @example
+     *   Net within 30 days
+     *
+     * @summary PAYMENT TERMS
+     *
+     * @name cac:PaymentTerms
+     */
+    paymentTerms: Schema.optional(PeppolPaymentTerms),
+
+    /**
+     * @description A group of business terms providing information about allowances applicable to the Invoice as a whole. A group of business terms providing
+     * information about charges and taxes other than VAT, applicable to the Invoice as a whole.
+     *
+     * @summary DOCUMENT LEVEL ALLOWANCES AND CHARGES
+     *
+     * @name cac:AllowanceCharge
+     */
+    allowanceCharges: Schema.optional(Schema.Array(peppolAllowanceChargeSchema)),
+
+    /**
+     * @description When tax currency code is provided, two instances of the tax total must be present, but only one with tax subtotal.
+     *
+     * @summary TAX TOTAL
+     *
+     * @name cac:TaxTotal
+     */
+    taxTotals: Schema.Array(PeppolTaxTotalsBase).check(Schema.isMinLength(1), Schema.isMaxLength(2)),
+
+    /**
+     * @summary DOCUMENT TOTALS
+     *
+     * @name cac:LegalMonetaryTotal
+     */
+    legalMonetaryTotal: PeppolLegalMonetaryTotal,
+  })
+) {}

package/src/schemas/peppol-credit-note-schema.ts

@@ -0,0 +1,31 @@
+import { Schema } from 'effect';
+
+import { PeppolCreditNoteLine } from '#/schemas/fields/peppol-credit-note-line-schema';
+import { PeppolBillingBase } from '#/schemas/peppol-billing-base-schema';
+import { opaque } from '#/schemas/utils/opaque';
+import { creditNoteTypeCodeSchema } from '#/schemas/values/credit-note-type-code-schema';
+
+/**
+ * @description Main UBL Credit Note schema (camelCase properties) Effect port of `creditNoteSchema` (`z.extend(billingBaseSchema, ...)` →
+ * `PeppolBillingBase.pipe(Schema.fieldsAssign(...))`).
+ */
+export class PeppolCreditNote extends opaque<PeppolCreditNote>()(
+  Schema.Struct({
+    ...PeppolBillingBase.fields,
+    /**
+     * @description CREDIT NOTE LINE.
+     *
+     * @name cac:CreditNoteLine (1..n)
+     */
+    creditNoteLines: Schema.Array(PeppolCreditNoteLine).check(Schema.isMinLength(1)),
+    /**
+     * @description Invoice type code A code specifying the functional type of the Credit Note.
+     *
+     * @example
+     *   381;
+     *
+     * @name cbc:CreditNoteTypeCode
+     */
+    creditNoteTypeCode: creditNoteTypeCodeSchema,
+  })
+) {}

package/src/schemas/peppol-document-response-document-reference-schema.ts

@@ -0,0 +1,41 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+import { peppolDocumentTypeCodeSchema } from '#/schemas/values/peppol-document-type-code-schema';
+
+export class PeppolDocumentResponseDocumentReference extends opaque<PeppolDocumentResponseDocumentReference>()(
+  Schema.Struct({
+    /**
+     * @description Identifies the document on which the message level response is based.
+     *
+     * @example
+     *   `EnvelopeID-12345`;
+     *
+     * @summary Document identifier
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String,
+    /**
+     * @description The type of the document being referred to, expressed as a code.
+     *
+     * @summary Document type code
+     *
+     * @name `cbc:DocumentTypeCode`
+     */
+    documentTypeCode: Schema.optional(peppolDocumentTypeCodeSchema),
+    /**
+     * @description The version of the document that has been identifier with the document identifier.
+     *
+     * @example
+     *   `2`;
+     *
+     * @summary Document version identifier
+     *
+     * @name `cbc:VersionID`
+     */
+    versionId: Schema.optional(Schema.String),
+  })
+) {}
+
+export type PeppolMessageLevelDocumentResponseDocumentReference = PeppolDocumentResponseDocumentReference;

package/src/schemas/peppol-document-response-document-schema.ts

@@ -0,0 +1,38 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+import { applicationResponseTypeCodeSchema } from '#/schemas/values/application-response-type-code-schema';
+
+/**
+ * @summary Response information
+ *
+ * @name `cac:Response`
+ *
+ * @cardinality (1..1)
+ *
+ * @see {@link messageLevelResponseDocumentResponseSchema}
+ */
+export class PeppolDocumentResponseDocument extends opaque<PeppolDocumentResponseDocument>()(
+  Schema.Struct({
+    /**
+     * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+     * response states that the document was not processed because of identified issues.
+     *
+     * @example
+     *   `RE`;
+     *
+     * @summary Message response code
+     *
+     * @name `cbc:ResponseCode`
+     */
+    responseCode: applicationResponseTypeCodeSchema,
+    /**
+     * @description Used to meake any comments or instructions relevant to the response. The use of this element requires manual assessment by the receiver.
+     *
+     * @summary Response textual notes
+     */
+    description: Schema.optional(Schema.String),
+  })
+) {}
+
+export type PeppolMessageLevelResponseDocumentResponseDocument = PeppolDocumentResponseDocument;

package/src/schemas/peppol-document-response-line-response-content-schema.ts

@@ -0,0 +1,49 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+import { applicationResponseTypeCodeSchema } from '#/schemas/values/application-response-type-code-schema';
+
+class PeppolStatus extends opaque<PeppolStatus>()(
+  Schema.Struct({
+    /**
+     * @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...
+     *
+     * @summary Issue type coded
+     *
+     * @name `cbc:StatusReasonCode`
+     */
+    statusReasonCode: Schema.Literals(['BV', 'BW', 'SV']),
+  })
+) {}
+
+export class PeppolDocumentResponseLineResponseContent extends opaque<PeppolDocumentResponseLineResponseContent>()(
+  Schema.Struct({
+    /**
+     * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+     * response states that the document was not processed because of identified issues.
+     *
+     * @example
+     *   `RE`;
+     *
+     * @summary Line response code
+     *
+     * @name `cbc:ResponseCode`
+     */
+    responseCode: applicationResponseTypeCodeSchema,
+    /**
+     * @description The description of the issued identifier in the transaction document.
+     *
+     * @example
+     *   `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;
+     *
+     * @summary Issue description
+     *
+     * @name `cbc:Description`
+     */
+    description: Schema.String,
+    /**
+     * @name `cac:Status`
+     */
+    status: PeppolStatus,
+  })
+) {}

package/src/schemas/peppol-document-response-line-response-schema.ts

@@ -0,0 +1,40 @@
+import { Schema } from 'effect';
+
+import { PeppolDocumentResponseLineResponseContent } from '#/schemas/peppol-document-response-line-response-content-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+class PeppolLineReference extends opaque<PeppolLineReference>()(
+  Schema.Struct({
+    /**
+     * @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business
+     * document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to
+     * provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is
+     * mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.
+     *
+     * @example
+     *   `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;
+     *
+     * @summary Section identifier
+     */
+    lineId: Schema.String,
+  })
+) {}
+
+export class PeppolDocumentResponseLineResponse extends opaque<PeppolDocumentResponseLineResponse>()(
+  Schema.Struct({
+    /**
+     * @description Identifies the line in the business document to which the reported issue applies.
+     *
+     * @summary Line reference
+     *
+     * @name `cac:LineReference`
+     */
+    lineReference: PeppolLineReference,
+    /**
+     * @summary Line response information
+     */
+    response: PeppolDocumentResponseLineResponseContent,
+  })
+) {}
+
+export type PeppolMessageLevelDocumentResponseLineResponse = PeppolDocumentResponseLineResponse;

package/src/schemas/peppol-document-schema.ts

@@ -0,0 +1,120 @@
+import type { SchemaAST } from 'effect';
+
+import { Effect, Predicate, Schema, SchemaGetter, SchemaIssue } from 'effect';
+import XMLBuilder from 'fast-xml-builder';
+import { XMLParser } from 'fast-xml-parser';
+
+import type { XmlNode } from '#/helpers/get-prop';
+import type { PeppolCreditNoteLine } from '#/schemas/fields/peppol-credit-note-line-schema';
+import type { PeppolInvoiceLine } from '#/schemas/fields/peppol-invoice-line-schema';
+
+import { INVOICE_RESPONSE_PROFILE_ID } from '#/constants/invoice-response-profile-id';
+import { MESSAGE_LEVEL_RESPONSE_PROFILE_ID } from '#/constants/message-level-response-profile-id';
+import { decodeCreditNote } from '#/decoders/decode-credit-note';
+import { decodeInvoice } from '#/decoders/decode-invoice';
+import { decodeInvoiceResponse } from '#/decoders/decode-invoice-response';
+import { decodeMessageLevelResponse } from '#/decoders/decode-message-level-response';
+import { encodeCreditNote } from '#/decoders/encode-credit-note';
+import { encodeInvoice } from '#/decoders/encode-invoice';
+import { encodeInvoiceResponse } from '#/decoders/encode-invoice-response';
+import { encodeMessageLevelResponse } from '#/decoders/encode-message-level-response';
+import { strOrUnd } from '#/helpers/str-or-und';
+import { PeppolCreditNote } from '#/schemas/peppol-credit-note-schema';
+import { PeppolInvoiceResponse } from '#/schemas/peppol-invoice-response-schema';
+import { PeppolInvoice } from '#/schemas/peppol-invoice-schema';
+import { PeppolMessageLevelResponse } from '#/schemas/peppol-message-level-response-schema';
+import { builderOptions } from '#/xml/builder-options';
+import { parserOptions } from '#/xml/parser-options';
+
+/**
+ * @description Object representation of a PEPPOL document, before the member schemas normalise it (dates stay strings, enums stay loose). This is the shape
+ * produced by the legacy `#/decoders/*` functions and consumed by their `#/decoders/encode-*` counterparts.
+ */
+const peppolDocumentObjectSchema = Schema.Union([PeppolInvoice, PeppolCreditNote, PeppolMessageLevelResponse, PeppolInvoiceResponse], {
+  mode: 'oneOf',
+});
+
+type PeppolDocumentObject = typeof peppolDocumentObjectSchema.Encoded;
+
+const parseXml = (value: string): XmlNode => new XMLParser({ ...parserOptions, removeNSPrefix: true }).parse(value);
+
+export const isPeppolInvoice = Schema.is(PeppolInvoice);
+export const isPeppolCreditNote = Schema.is(PeppolCreditNote);
+export const isPeppolMessageLevelResponse = Schema.is(PeppolMessageLevelResponse);
+export const isPeppolInvoiceResponse = Schema.is(PeppolInvoiceResponse);
+
+/**
+ * @description XML string -> loose document object. Dispatches on the root element; `ApplicationResponse` is further split by its `cbc:ProfileID`.
+ */
+const decodeDocumentXml = Effect.fn('decode-peppol-document-xml')(function* (value: string, options: SchemaAST.ParseOptions) {
+  const parsed = parseXml(value);
+
+  if (Predicate.isNotNullish(parsed.Invoice)) {
+    return yield* decodeInvoice(parsed);
+  }
+  if (Predicate.isNotNullish(parsed.CreditNote)) {
+    return yield* decodeCreditNote(parsed);
+  }
+  if (Predicate.isNotNullish(parsed.ApplicationResponse)) {
+    const profileId = yield* strOrUnd(parsed.ApplicationResponse, 'cbc:ProfileID');
+    if (profileId === MESSAGE_LEVEL_RESPONSE_PROFILE_ID) {
+      return yield* decodeMessageLevelResponse(parsed);
+    }
+    if (profileId === INVOICE_RESPONSE_PROFILE_ID) {
+      return yield* decodeInvoiceResponse(parsed);
+    }
+  }
+
+  const rootNodes = Object.keys(parsed);
+  return yield* Effect.fail(new SchemaIssue.InvalidValue({ message: `Unsupported document type: ${rootNodes.join(',')}` }, value, options));
+});
+
+/**
+ * @description Loose document object -> XML string. Mirrors {@link decodeDocumentXml} by dispatching on the decoded discriminant.
+ */
+const encodeDocumentXml = Effect.fn('encode-peppol-document-xml')(function* (value: PeppolDocumentObject, options: SchemaAST.ParseOptions) {
+  let content: unknown;
+
+  if (isPeppolInvoice(value) || Predicate.hasProperty(value, 'invoiceLines')) {
+    content = yield* encodeInvoice(value as never);
+  } else if (isPeppolCreditNote(value) || Predicate.hasProperty(value, 'creditNoteLines')) {
+    content = yield* encodeCreditNote(value as never);
+  } else if (isPeppolMessageLevelResponse(value) || value.profileId === MESSAGE_LEVEL_RESPONSE_PROFILE_ID) {
+    content = yield* encodeMessageLevelResponse(value as never);
+  } else if (isPeppolInvoiceResponse(value) || value.profileId === INVOICE_RESPONSE_PROFILE_ID) {
+    content = yield* encodeInvoiceResponse(value as never);
+  } else {
+    const rootNodes = Object.keys(value);
+    console.log(value, isPeppolInvoice(value), isPeppolCreditNote(value), isPeppolMessageLevelResponse(value), isPeppolInvoiceResponse(value));
+    return yield* Effect.fail(
+      new SchemaIssue.InvalidValue({ message: `Unsupported document type: ${value.profileId}\n${rootNodes.join(',')}` }, value, options)
+    );
+  }
+
+  return new XMLBuilder(builderOptions).build(content) as string;
+});
+
+/**
+ * @description Union of every supported PEPPOL business document. Members discriminate cleanly: invoice vs credit note via `invoiceLines`/`creditNoteLines`,
+ * message-level vs invoice response via the `profileId` literal.
+ */
+export const peppolDocumentSchema = peppolDocumentObjectSchema.pipe(
+  Schema.encodeTo(Schema.String, {
+    encode: SchemaGetter.transformEffect((value, options) => encodeDocumentXml(value, options)),
+    decode: SchemaGetter.transformEffect((value, options) => decodeDocumentXml(value, options)),
+  })
+);
+
+export type PeppolDocumentEncoded = Schema.Codec.Encoded<typeof peppolDocumentSchema>;
+export type PeppolDocumentDecoded = Schema.Schema.Type<typeof peppolDocumentSchema>;
+
+/**
+ * @description This defines the types of documents that are sent/received through the peppol network.
+ */
+export type PeppolDocument = PeppolInvoice | PeppolCreditNote;
+/**
+ * @description This defines the types of message that are sent/received through the peppol network.
+ */
+export type PeppolMessage = PeppolMessageLevelResponse | PeppolInvoiceResponse;
+export type PeppolAllDocuments = PeppolDocument | PeppolMessage;
+export type PeppolDocumentLine = PeppolInvoiceLine | PeppolCreditNoteLine;