@endevops/peppol-schema 0.1.3 → 0.1.4

package/src/schemas/fields/peppol-party-tax-scheme-schema.ts

@@ -14,6 +14,8 @@ class PeppolTaxSchemeId extends opaque<PeppolTaxSchemeId>()(
 ) {}
 
 /**
+ * @description The Seller tax registration details, combining a tax identifier such as a VAT number with the tax scheme.
+ *
  * @name cac:PartyTaxScheme (0..2)
  */
 export class PeppolPartyTaxScheme extends opaque<PeppolPartyTaxScheme>()(
@@ -38,4 +40,7 @@ export class PeppolPartyTaxScheme extends opaque<PeppolPartyTaxScheme>()(
   })
 ) {}
 
+/**
+ * @description Alias for {@link PeppolPartyTaxScheme}.
+ */
 export type PeppolPartyTaxSchema = PeppolPartyTaxScheme;

package/src/schemas/fields/peppol-payee-party-schema.ts

@@ -2,7 +2,7 @@ import { Schema } from 'effect';
 
 import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { icdCodesSchema } from '#/schemas/values/icd-codes-schema.ts';
+import { PeppolIcdCode } from '#/schemas/values/icd-codes-schema.ts';
 
 class PeppolPartyName extends opaque<PeppolPartyName>()(Schema.Struct({ name: Schema.String })) {}
 
@@ -39,7 +39,7 @@ class PeppolPartyLegalEntity extends opaque<PeppolPartyLegalEntity>()(
            *
            * @name `@schemeID`
            */
-          schemeId: Schema.optional(icdCodesSchema),
+          schemeId: Schema.optional(PeppolIcdCode),
         })
       )
     ),

package/src/schemas/fields/peppol-payment-means-schema.ts

@@ -2,8 +2,18 @@ import { Schema } from 'effect';
 
 import { PeppolIsoDateString } from '#/schemas/peppol-iso-date-string.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { paymentMeansCodeSchema } from '#/schemas/values/payment-means-code-schema.ts';
+import { PeppolPaymentMeansCodeValue } from '#/schemas/values/payment-means-code-schema.ts';
 
+/**
+ * @description The account to be debited by a direct debit.
+ *
+ * @example
+ *   ```ts
+ *   { id: '12345676543' }
+ *   ```;
+ *
+ * @see {@link PeppolPaymentMandate}
+ */
 export class PeppolPaymentMandatePayerFinancialAccountId extends opaque<PeppolPaymentMandatePayerFinancialAccountId>()(
   Schema.Struct({
     /**
@@ -20,6 +30,16 @@ export class PeppolPaymentMandatePayerFinancialAccountId extends opaque<PeppolPa
   })
 ) {}
 
+/**
+ * @description A group of business terms to specify a direct debit, including the mandate reference and the debited account.
+ *
+ * @example
+ *   ```ts
+ *   { id: 'MandateReference', payerFinancialAccountId: { id: '12345676543' } }
+ *   ```;
+ *
+ * @see {@link PeppolPaymentMeans}
+ */
 export class PeppolPaymentMandate extends opaque<PeppolPaymentMandate>()(
   Schema.Struct({
     /**
@@ -44,6 +64,16 @@ export class PeppolPaymentMandate extends opaque<PeppolPaymentMandate>()(
   })
 ) {}
 
+/**
+ * @description The payment service provider where the payee payment account is held, such as a BIC or national clearing code.
+ *
+ * @example
+ *   ```ts
+ *   { id: 'BIC324098' }
+ *   ```;
+ *
+ * @see {@link PeppolPayeeFinancialAccount}
+ */
 export class PeppolPayeeFinancialAccountFinancialInstitutionBranch extends opaque<PeppolPayeeFinancialAccountFinancialInstitutionBranch>()(
   Schema.Struct({
     /**
@@ -61,6 +91,16 @@ export class PeppolPayeeFinancialAccountFinancialInstitutionBranch extends opaqu
   })
 ) {}
 
+/**
+ * @description The payment account to which payment should be made, such as an IBAN or BBAN, including the financial institution branch.
+ *
+ * @example
+ *   ```ts
+ *   { id: 'IBAN32423940', name: 'AccountName' }
+ *   ```;
+ *
+ * @see {@link PeppolPaymentMeans}
+ */
 export class PeppolPayeeFinancialAccount extends opaque<PeppolPayeeFinancialAccount>()(
   Schema.Struct({
     /**
@@ -94,6 +134,16 @@ export class PeppolPayeeFinancialAccount extends opaque<PeppolPayeeFinancialAcco
   })
 ) {}
 
+/**
+ * @description The card used for payment, including the card holder name and the primary account number.
+ *
+ * @example
+ *   ```ts
+ *   { networkId: 'VISA', primaryAccountNumberId: '1234' }
+ *   ```;
+ *
+ * @see {@link PeppolPaymentMeans}
+ */
 export class PeppolCardAccount extends opaque<PeppolCardAccount>()(
   Schema.Struct({
     /**
@@ -125,6 +175,16 @@ export class PeppolCardAccount extends opaque<PeppolCardAccount>()(
   })
 ) {}
 
+/**
+ * @description The means by which a payment is expected to be or has been settled, expressed as a UNCL 4461 code and optional text.
+ *
+ * @example
+ *   ```ts
+ *   { code: '30', name: 'Credit transfer' }
+ *   ```;
+ *
+ * @see {@link PeppolPaymentMeans}
+ */
 export class PeppolPaymentMeansCode extends opaque<PeppolPaymentMeansCode>()(
   Schema.Struct({
     /**
@@ -137,7 +197,7 @@ export class PeppolPaymentMeansCode extends opaque<PeppolPaymentMeansCode>()(
      *
      * @name `#text`
      */
-    code: paymentMeansCodeSchema,
+    code: PeppolPaymentMeansCodeValue,
     /**
      * @description The means, expressed as text, for how a payment is expected to be or has been settled.
      *

package/src/schemas/fields/peppol-payment-terms-schema.ts

@@ -3,6 +3,8 @@ import { Schema } from 'effect';
 import { opaque } from '#/schemas/utils/opaque.ts';
 
 /**
+ * @description A textual description of the payment terms that apply to the amount due for payment.
+ *
  * @summary PAYMENT TERMS
  *
  * @name cac:PaymentTerms

package/src/schemas/fields/peppol-quantity-schema.ts

@@ -1,9 +1,11 @@
 import { Schema } from 'effect';
 
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { quantityUnitCodesSchema } from '#/schemas/values/quantity-unit-codes-schema.ts';
+import { PeppolQuantityUnitCode } from '#/schemas/values/quantity-unit-codes-schema.ts';
 
 /**
+ * @description A quantity value with an optional unit of measure code.
+ *
  * @summary Quantity with optional unit code
  *
  * @name `cbc:* (+ @unitCode)`
@@ -13,7 +15,7 @@ export class PeppolQuantity extends opaque<PeppolQuantity>()(
     /**
      * @name `@unitCode`
      */
-    unitCode: Schema.optional(quantityUnitCodesSchema),
+    unitCode: Schema.optional(PeppolQuantityUnitCode),
     /**
      * @name `#text (value)`
      */

package/src/schemas/fields/peppol-reference-schema.ts

@@ -2,8 +2,27 @@ import { Schema } from 'effect';
 
 import { opaque } from '#/schemas/utils/opaque.ts';
 
+/**
+ * @description A reference identifier, such as an order or sales order reference.
+ *
+ * @example
+ *   ```ts
+ *   { id: '123' }
+ *   ```;
+ */
 export class PeppolReferenceId extends opaque<PeppolReferenceId>()(Schema.Struct({ id: Schema.String })) {}
 
+/**
+ * @description A schema for an optional reference identifier, accepting either {@link PeppolReferenceId} or `undefined`.
+ *
+ * @example
+ *   ```ts
+ *   peppolReferenceSchema; // Schema.Union([PeppolReferenceId, Schema.Undefined])
+ *   ```;
+ */
 export const peppolReferenceSchema = Schema.Union([PeppolReferenceId, Schema.Undefined]);
 
-export type PeppolReferenceSchema = typeof peppolReferenceSchema.Type;
+/**
+ * @description The decoded type of {@link peppolReferenceSchema}, either a {@link PeppolReferenceId} or `undefined`.
+ */
+export type PeppolReferenceSchema = Schema.Schema.Type<typeof peppolReferenceSchema>;

package/src/schemas/fields/peppol-tax-category-schema.ts

@@ -1,8 +1,18 @@
 import { Effect, Schema } from 'effect';
 
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { peppolDutyTaxFeeCategorySchema } from '#/schemas/values/duty-tax-fee-category-schema.ts';
+import { PeppolDutyTaxFeeCategoryCode } from '#/schemas/values/duty-tax-fee-category-schema.ts';
 
+/**
+ * @description The tax scheme identifier for a tax category, defaulting to `VAT` when the element is absent.
+ *
+ * @example
+ *   ```ts
+ *   { id: 'VAT' }
+ *   ```;
+ *
+ * @see {@link PeppolTaxCategory}
+ */
 export class PeppolTaxSchemeId extends opaque<PeppolTaxSchemeId>()(
   Schema.Struct({
     /**
@@ -28,7 +38,7 @@ export class PeppolTaxCategory extends opaque<PeppolTaxCategory>()(
      *
      * @name `cbc:ID`
      */
-    id: peppolDutyTaxFeeCategorySchema,
+    id: PeppolDutyTaxFeeCategoryCode,
     /**
      * @description The VAT rate, represented as percentage that applies to the invoiced item.
      *

package/src/schemas/fields/peppol-tax-representative-schema.ts

@@ -5,6 +5,8 @@ import { PeppolPartyTaxScheme } from '#/schemas/fields/peppol-party-tax-scheme-s
 import { opaque } from '#/schemas/utils/opaque.ts';
 
 /**
+ * @description The party acting as the Seller tax representative, including its name, postal address, and tax scheme.
+ *
  * @summary SELLER TAX REPRESENTATIVE PARTY
  *
  * @name cac:TaxRepresentativeParty
@@ -23,4 +25,7 @@ export class PeppolTaxRepresentative extends opaque<PeppolTaxRepresentative>()(
   })
 ) {}
 
+/**
+ * @description Alias for {@link PeppolTaxRepresentative}.
+ */
 export type PeppolTaxRepresentativeParty = PeppolTaxRepresentative;

package/src/schemas/fields/peppol-tax-subtotal-category-schema.ts

@@ -28,4 +28,7 @@ export class PeppolTaxSubTotalCategory extends opaque<PeppolTaxSubTotalCategory>
   })
 ) {}
 
+/**
+ * @description The encoded form of {@link PeppolTaxSubTotalCategory}, accepted by the decoder before branded code values are applied.
+ */
 export interface PeppolTaxSubTotalCategoryEncoded extends Schema.Codec.Encoded<typeof PeppolTaxSubTotalCategory> {}

package/src/schemas/fields/peppol-tax-subtotal-schema.ts

@@ -5,6 +5,8 @@ import { PeppolTaxSubTotalCategory } from '#/schemas/fields/peppol-tax-subtotal-
 import { opaque } from '#/schemas/utils/opaque.ts';
 
 /**
+ * @description A VAT breakdown line for a single tax category, giving the taxable amount and the tax amount.
+ *
  * @summary VAT breakdown (TaxSubtotal)
  *
  * @name cac:TaxSubtotal

package/src/schemas/fields/peppol-tax-totals-base-schema.ts

@@ -5,6 +5,8 @@ import { PeppolTaxSubTotal } from '#/schemas/fields/peppol-tax-subtotal-schema.t
 import { opaque } from '#/schemas/utils/opaque.ts';
 
 /**
+ * @description The total tax amount for the document, with an optional breakdown into tax subtotals.
+ *
  * @summary TAX TOTAL
  *
  * @name cac:TaxTotal (1..2)
@@ -25,4 +27,7 @@ export class PeppolTaxTotalsBase extends opaque<PeppolTaxTotalsBase>()(
   })
 ) {}
 
+/**
+ * @description Alias for {@link PeppolTaxTotalsBase}.
+ */
 export type PeppolTaxTotal = PeppolTaxTotalsBase;

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

@@ -3,7 +3,7 @@ import { Effect, Schema } from 'effect';
 import { DEFAULT_CUSTOMIZATION_ID } from '#/schemas/fields/default-customization-id.ts';
 import { DEFAULT_PROFILE_ID } from '#/schemas/fields/default-profile-id.ts';
 import { PeppolAdditionalDocumentReference } from '#/schemas/fields/peppol-additional-document-reference-schema.ts';
-import { peppolAllowanceChargeSchema } from '#/schemas/fields/peppol-allowance-charge-schema.ts';
+import { PeppolAllowanceCharge } from '#/schemas/fields/peppol-allowance-charge-schema.ts';
 import { PeppolBillingReference } from '#/schemas/fields/peppol-billing-reference-schema.ts';
 import { PeppolDelivery } from '#/schemas/fields/peppol-delivery-schema.ts';
 import { PeppolInvoicePeriod } from '#/schemas/fields/peppol-invoice-period-schema.ts';
@@ -17,8 +17,18 @@ import { PeppolTaxRepresentative } from '#/schemas/fields/peppol-tax-representat
 import { PeppolTaxTotalsBase } from '#/schemas/fields/peppol-tax-totals-base-schema.ts';
 import { PeppolIsoDateString } from '#/schemas/peppol-iso-date-string.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { currencyCodeSchema } from '#/schemas/values/currency-code-schema.ts';
+import { PeppolCurrencyCode } from '#/schemas/values/currency-code-schema.ts';
 
+/**
+ * @description Wraps the `cac:ContractDocumentReference` element: an identifier of a contract that the billing document references.
+ *
+ * @example
+ *   ```ts
+ *   { id: '123Contractref' }
+ *   ```;
+ *
+ * @see {@link PeppolBillingBase}
+ */
 export class PeppolContractDocumentReference extends opaque<PeppolContractDocumentReference>()(
   Schema.Struct({
     /**
@@ -35,6 +45,16 @@ export class PeppolContractDocumentReference extends opaque<PeppolContractDocume
   })
 ) {}
 
+/**
+ * @description Wraps the `cac:OriginatorDocumentReference` element: the identification of the call for tender or lot the invoice relates to.
+ *
+ * @example
+ *   ```ts
+ *   { id: 'PPID-123' }
+ *   ```;
+ *
+ * @see {@link PeppolBillingBase}
+ */
 export class PeppolOriginatorDocumentReference extends opaque<PeppolOriginatorDocumentReference>()(
   Schema.Struct({
     /**
@@ -51,6 +71,16 @@ export class PeppolOriginatorDocumentReference extends opaque<PeppolOriginatorDo
   })
 ) {}
 
+/**
+ * @description Wraps the `cac:ReceiptDocumentReference` element: an identifier of a referenced receiving advice.
+ *
+ * @example
+ *   ```ts
+ *   { id: 'rec98' }
+ *   ```;
+ *
+ * @see {@link PeppolBillingBase}
+ */
 export class PeppolReceiptDocumentReference extends opaque<PeppolReceiptDocumentReference>()(
   Schema.Struct({
     /**
@@ -67,6 +97,16 @@ export class PeppolReceiptDocumentReference extends opaque<PeppolReceiptDocument
   })
 ) {}
 
+/**
+ * @description Wraps the `cac:DespatchDocumentReference` element: an identifier of a referenced despatch advice.
+ *
+ * @example
+ *   ```ts
+ *   { id: 'desp98' }
+ *   ```;
+ *
+ * @see {@link PeppolBillingBase}
+ */
 export class PeppolDespatchDocumentReference extends opaque<PeppolDespatchDocumentReference>()(
   Schema.Struct({
     /**
@@ -86,8 +126,8 @@ export class PeppolDespatchDocumentReference extends opaque<PeppolDespatchDocume
 /**
  * @description Base schema for a billing document.
  *
- * @see {@link creditNoteSchema} - the credit note schema
- * @see {@link invoiceSchema} - the invoice schema
+ * @see {@link PeppolCreditNote} - the credit note schema
+ * @see {@link PeppolInvoice} - the invoice schema
  */
 export class PeppolBillingBase extends opaque<PeppolBillingBase>()(
   Schema.Struct({
@@ -182,7 +222,7 @@ export class PeppolBillingBase extends opaque<PeppolBillingBase>()(
      *
      * @name `cbc:DocumentCurrencyCode`
      */
-    documentCurrencyCode: currencyCodeSchema,
+    documentCurrencyCode: PeppolCurrencyCode,
     /**
      * @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
@@ -195,7 +235,7 @@ export class PeppolBillingBase extends opaque<PeppolBillingBase>()(
      *
      * @name `cbc:TaxCurrencyCode`
      */
-    taxCurrencyCode: Schema.optional(currencyCodeSchema),
+    taxCurrencyCode: Schema.optional(PeppolCurrencyCode),
     /**
      * @description A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
      *
@@ -345,7 +385,7 @@ export class PeppolBillingBase extends opaque<PeppolBillingBase>()(
      *
      * @name cac:AllowanceCharge
      */
-    allowanceCharges: Schema.optional(Schema.Array(peppolAllowanceChargeSchema)),
+    allowanceCharges: Schema.optional(Schema.Array(PeppolAllowanceCharge)),
 
     /**
      * @description When tax currency code is provided, two instances of the tax total must be present, but only one with tax subtotal.

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

@@ -3,7 +3,7 @@ import { Schema } from 'effect';
 import { PeppolCreditNoteLine } from '#/schemas/fields/peppol-credit-note-line-schema.ts';
 import { PeppolBillingBase } from '#/schemas/peppol-billing-base-schema.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { creditNoteTypeCodeSchema } from '#/schemas/values/credit-note-type-code-schema.ts';
+import { PeppolCreditNoteTypeCode } from '#/schemas/values/credit-note-type-code-schema.ts';
 
 /**
  * @description Main UBL Credit Note schema (camelCase properties) Effect port of `creditNoteSchema` (`z.extend(billingBaseSchema, ...)` →
@@ -26,6 +26,6 @@ export class PeppolCreditNote extends opaque<PeppolCreditNote>()(
      *
      * @name cbc:CreditNoteTypeCode
      */
-    creditNoteTypeCode: creditNoteTypeCodeSchema,
+    creditNoteTypeCode: PeppolCreditNoteTypeCode,
   })
 ) {}

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

@@ -1,8 +1,18 @@
 import { Schema } from 'effect';
 
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { peppolDocumentTypeCodeSchema } from '#/schemas/values/peppol-document-type-code-schema.ts';
+import { PeppolDocumentTypeCode } from '#/schemas/values/peppol-document-type-code-schema.ts';
 
+/**
+ * @description Wraps `cac:DocumentReference` inside a message level response: identifies the business document the response is based on.
+ *
+ * @example
+ *   ```ts
+ *   { id: 'EnvelopeID-12345', versionId: '2' }
+ *   ```;
+ *
+ * @see {@link PeppolMessageLevelResponseDocumentResponse}
+ */
 export class PeppolDocumentResponseDocumentReference extends opaque<PeppolDocumentResponseDocumentReference>()(
   Schema.Struct({
     /**
@@ -23,7 +33,7 @@ export class PeppolDocumentResponseDocumentReference extends opaque<PeppolDocume
      *
      * @name `cbc:DocumentTypeCode`
      */
-    documentTypeCode: Schema.optional(peppolDocumentTypeCodeSchema),
+    documentTypeCode: Schema.optional(PeppolDocumentTypeCode),
     /**
      * @description The version of the document that has been identifier with the document identifier.
      *
@@ -38,4 +48,7 @@ export class PeppolDocumentResponseDocumentReference extends opaque<PeppolDocume
   })
 ) {}
 
+/**
+ * @description Alias of {@link PeppolDocumentResponseDocumentReference} under the message level response naming.
+ */
 export type PeppolMessageLevelDocumentResponseDocumentReference = PeppolDocumentResponseDocumentReference;

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

@@ -1,16 +1,18 @@
 import { Schema } from 'effect';
 
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { applicationResponseTypeCodeSchema } from '#/schemas/values/application-response-type-code-schema.ts';
+import { PeppolApplicationResponseTypeCode } from '#/schemas/values/application-response-type-code-schema.ts';
 
 /**
+ * @description Wraps `cac:Response` inside a message level response: the overall response code and an optional textual note.
+ *
  * @summary Response information
  *
  * @name `cac:Response`
  *
  * @cardinality (1..1)
  *
- * @see {@link messageLevelResponseDocumentResponseSchema}
+ * @see {@link PeppolMessageLevelResponseDocumentResponse}
  */
 export class PeppolDocumentResponseDocument extends opaque<PeppolDocumentResponseDocument>()(
   Schema.Struct({
@@ -25,7 +27,7 @@ export class PeppolDocumentResponseDocument extends opaque<PeppolDocumentRespons
      *
      * @name `cbc:ResponseCode`
      */
-    responseCode: applicationResponseTypeCodeSchema,
+    responseCode: PeppolApplicationResponseTypeCode,
     /**
      * @description Used to meake any comments or instructions relevant to the response. The use of this element requires manual assessment by the receiver.
      *
@@ -35,4 +37,7 @@ export class PeppolDocumentResponseDocument extends opaque<PeppolDocumentRespons
   })
 ) {}
 
+/**
+ * @description Alias of {@link PeppolDocumentResponseDocument} under the message level response naming.
+ */
 export type PeppolMessageLevelResponseDocumentResponseDocument = PeppolDocumentResponseDocument;

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

@@ -1,8 +1,18 @@
 import { Schema } from 'effect';
 
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { applicationResponseTypeCodeSchema } from '#/schemas/values/application-response-type-code-schema.ts';
+import { PeppolApplicationResponseTypeCode } from '#/schemas/values/application-response-type-code-schema.ts';
 
+/**
+ * @description Wraps `cac:Status` inside a line response: the coded reason for an issue found in the document.
+ *
+ * @example
+ *   ```ts
+ *   { statusReasonCode: 'SV' }
+ *   ```;
+ *
+ * @see {@link PeppolDocumentResponseLineResponseContent}
+ */
 export class PeppolStatus extends opaque<PeppolStatus>()(
   Schema.Struct({
     /**
@@ -16,6 +26,16 @@ export class PeppolStatus extends opaque<PeppolStatus>()(
   })
 ) {}
 
+/**
+ * @description A response to a particular line in the business document: the line response code, a description of the issue and its coded status.
+ *
+ * @example
+ *   ```ts
+ *   { responseCode: 'RE', description: 'Validation gives error [CL-T77-R0002]', status: { statusReasonCode: 'SV' } }
+ *   ```;
+ *
+ * @see {@link PeppolDocumentResponseLineResponse}
+ */
 export class PeppolDocumentResponseLineResponseContent extends opaque<PeppolDocumentResponseLineResponseContent>()(
   Schema.Struct({
     /**
@@ -29,7 +49,7 @@ export class PeppolDocumentResponseLineResponseContent extends opaque<PeppolDocu
      *
      * @name `cbc:ResponseCode`
      */
-    responseCode: applicationResponseTypeCodeSchema,
+    responseCode: PeppolApplicationResponseTypeCode,
     /**
      * @description The description of the issued identifier in the transaction document.
      *

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

@@ -3,6 +3,16 @@ import { Schema } from 'effect';
 import { PeppolDocumentResponseLineResponseContent } from '#/schemas/peppol-document-response-line-response-content-schema.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
 
+/**
+ * @description Wraps `cac:LineReference` inside a line response: an XPath pointing at the element that caused the reported issue.
+ *
+ * @example
+ *   ```ts
+ *   { lineId: '/Invoice/cac:InvoiceLine[1]' }
+ *   ```;
+ *
+ * @see {@link PeppolDocumentResponseLineResponse}
+ */
 export class PeppolLineReference extends opaque<PeppolLineReference>()(
   Schema.Struct({
     /**
@@ -20,6 +30,19 @@ export class PeppolLineReference extends opaque<PeppolLineReference>()(
   })
 ) {}
 
+/**
+ * @description Wraps `cac:LineResponse` inside a message level response: pairs a line reference with the response for that line.
+ *
+ * @example
+ *   ```ts
+ *   {
+ *     lineReference: { lineId: '/Invoice/cac:InvoiceLine[1]' },
+ *     response: { responseCode: 'RE', description: 'Invalid tax category', status: { statusReasonCode: 'SV' } }
+ *   }
+ *   ```;
+ *
+ * @see {@link PeppolMessageLevelResponseDocumentResponse}
+ */
 export class PeppolDocumentResponseLineResponse extends opaque<PeppolDocumentResponseLineResponse>()(
   Schema.Struct({
     /**
@@ -37,4 +60,7 @@ export class PeppolDocumentResponseLineResponse extends opaque<PeppolDocumentRes
   })
 ) {}
 
+/**
+ * @description Alias of {@link PeppolDocumentResponseLineResponse} under the message level response naming.
+ */
 export type PeppolMessageLevelDocumentResponseLineResponse = PeppolDocumentResponseLineResponse;