@endevops/peppol-schema 0.0.1 → 0.1.0-beta.2

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

@@ -0,0 +1,29 @@
+import { Schema } from 'effect';
+
+import { peppolTaxCategorySchema } from './peppol-tax-category-schema';
+
+/**
+ * @description This one is specific for TaxSubtotal since it includes more fields.
+ *
+ * @summary Tax Category for Tax Subtotal
+ *
+ * @name cac:TaxCategory
+ */
+export const peppolTaxSubtotalCategorySchema = peppolTaxCategorySchema.pipe(
+  Schema.fieldsAssign({
+    /**
+     * @description The reason for the tax exemption.
+     *
+     * @name cbc:TaxExemptionReason
+     */
+    taxExemptionReason: Schema.optional(Schema.String),
+    /**
+     * @description The code for the reason of the tax exemption.
+     *
+     * @name cbc:TaxExemptionReasonCode
+     */
+    taxExemptionReasonCode: Schema.optional(Schema.String),
+  })
+);
+
+export type PeppolTaxSubTotalCategory = typeof peppolTaxSubtotalCategorySchema.Type;

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

@@ -0,0 +1,32 @@
+import { Schema } from 'effect';
+
+import { peppolAmountSchema } from './peppol-amount-schema';
+import { peppolTaxSubtotalCategorySchema } from './peppol-tax-subtotal-category-schema';
+
+/**
+ * @summary VAT breakdown (TaxSubtotal)
+ *
+ * @name cac:TaxSubtotal
+ */
+export const peppolTaxSubtotalSchema = Schema.Struct({
+  /**
+   * @description The amount of tax for the tax subtotal.
+   *
+   * @name `cbc:TaxAmount (+ @currencyID)`
+   */
+  taxAmount: peppolAmountSchema,
+  /**
+   * @description The tax category associated with this tax subtotal.
+   *
+   * @name cac:TaxCategory
+   */
+  taxCategory: peppolTaxSubtotalCategorySchema,
+  /**
+   * @description The taxable amount for the tax subtotal.
+   *
+   * @name `cbc:TaxableAmount (+ @currencyID)`
+   */
+  taxableAmount: peppolAmountSchema,
+});
+
+export type PeppolTaxSubTotal = typeof peppolTaxSubtotalSchema.Type;

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

@@ -0,0 +1,25 @@
+import { Schema } from 'effect';
+
+import { peppolAmountSchema } from './peppol-amount-schema';
+import { peppolTaxSubtotalSchema } from './peppol-tax-subtotal-schema';
+
+/**
+ * @summary TAX TOTAL
+ *
+ * @name cac:TaxTotal (1..2)
+ */
+export const peppolTaxTotalsBaseSchema = Schema.Struct({
+  /**
+   * @example
+   *   200;
+   *
+   * @name cbc:TaxAmount (+ @currencyID)
+   */
+  taxAmount: peppolAmountSchema,
+  /**
+   * @name cac:TaxSubtotal (0..n)
+   */
+  taxSubtotals: Schema.optional(Schema.Array(peppolTaxSubtotalSchema)),
+});
+
+export type PeppolTaxTotal = typeof peppolTaxTotalsBaseSchema.Type;

package/src/effect/index.ts

@@ -0,0 +1,56 @@
+export * from './peppol-iso-date-string-schema';
+export * from './peppol-billing-base-schema';
+export * from './peppol-invoice-schema';
+export * from './peppol-credit-note-schema';
+export * from './peppol-message-level-response-party-schema';
+export * from './peppol-document-response-document-reference-schema';
+export * from './peppol-document-response-document-schema';
+export * from './peppol-document-response-line-response-content-schema';
+export * from './peppol-document-response-line-response-schema';
+export * from './peppol-message-level-response-document-response-schema';
+export * from './peppol-message-level-response-schema';
+export * from './peppol-invoice-response-status-reason-code-schema';
+export * from './peppol-invoice-response-document-actual-response-status-schema';
+export * from './peppol-invoice-response-document-actual-response-schema';
+export * from './peppol-invoice-response-schema';
+export * from './peppol-document-schema';
+
+export * from './fields/peppol-additional-document-reference-schema';
+export * from './fields/peppol-address-schema';
+export * from './fields/peppol-allowance-charge-schema';
+export * from './fields/peppol-amount-schema';
+export * from './fields/peppol-base-line-schema';
+export * from './fields/peppol-billing-reference-schema';
+export * from './fields/peppol-binary-object-schema';
+export * from './fields/peppol-contact-schema';
+export * from './fields/peppol-credit-note-line-schema';
+export * from './fields/default-customization-id';
+export * from './fields/default-profile-id';
+export * from './fields/peppol-delivery-schema';
+export * from './fields/identifier-schema';
+export * from './fields/peppol-invoice-line-period-schema';
+export * from './fields/peppol-invoice-line-schema';
+export * from './fields/peppol-invoice-period-schema';
+export * from './fields/peppol-legal-monetary-total-schema';
+export * from './fields/peppol-line-allowance-charge-schema';
+export * from './fields/peppol-line-item-schema';
+export * from './fields/peppol-line-price-allowance-charge-schema';
+export * from './fields/peppol-item-classification-schema';
+export * from './fields/peppol-order-reference-schema';
+export * from './fields/peppol-party-base-schema';
+export * from './fields/peppol-party-legal-entity-schema';
+export * from './fields/peppol-party-tax-scheme-schema';
+export * from './fields/peppol-payee-party-schema';
+export * from './fields/peppol-payment-means-schema';
+export * from './fields/peppol-payment-terms-schema';
+export * from './fields/peppol-line-price-schema';
+export * from './fields/peppol-quantity-schema';
+export * from './fields/peppol-reference-schema';
+export * from './fields/peppol-tax-category-schema';
+export * from './fields/peppol-tax-representative-schema';
+export * from './fields/peppol-tax-subtotal-category-schema';
+export * from './fields/peppol-tax-subtotal-schema';
+export * from './fields/peppol-tax-totals-base-schema';
+
+export * from './utils/index';
+export * from './values/index';

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

@@ -0,0 +1,357 @@
+import { Effect, Schema } from 'effect';
+
+import { DEFAULT_CUSTOMIZATION_ID } from './fields/default-customization-id';
+import { DEFAULT_PROFILE_ID } from './fields/default-profile-id';
+import { peppolAdditionalDocumentReferenceSchema } from './fields/peppol-additional-document-reference-schema';
+import { peppolAllowanceChargeSchema } from './fields/peppol-allowance-charge-schema';
+import { peppolBillingReferenceSchema } from './fields/peppol-billing-reference-schema';
+import { peppolDeliverySchema } from './fields/peppol-delivery-schema';
+import { peppolInvoicePeriodSchema } from './fields/peppol-invoice-period-schema';
+import { peppolLegalMonetaryTotalSchema } from './fields/peppol-legal-monetary-total-schema';
+import { peppolOrderReferenceSchema } from './fields/peppol-order-reference-schema';
+import { peppolPartyBaseSchema } from './fields/peppol-party-base-schema';
+import { peppolPayeePartySchema } from './fields/peppol-payee-party-schema';
+import { peppolPaymentMeansSchema } from './fields/peppol-payment-means-schema';
+import { peppolPaymentTermsSchema } from './fields/peppol-payment-terms-schema';
+import { peppolTaxRepresentativeSchema } from './fields/peppol-tax-representative-schema';
+import { peppolTaxTotalsBaseSchema } from './fields/peppol-tax-totals-base-schema';
+import { peppolIsoDateStringSchema } from './peppol-iso-date-string-schema';
+import { currencyCodeSchema } from './values/currency-code-schema';
+
+/**
+ * @description Base schema for a billing document. Effect port of `billingBaseSchema` (`z.object(...)`): same keys and optionality (`z.optional` →
+ * `Schema.optional`), ISO dates stay plain strings via `peppolIsoDateStringSchema` (never `Date` objects), and `z._default` becomes
+ * `Schema.withDecodingDefaultType`.
+ *
+ * @see {@link creditNoteSchema} - the credit note schema
+ * @see {@link invoiceSchema} - the invoice schema
+ */
+export const peppolBillingBaseSchema = 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.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'.",
+    })
+  ).pipe(Schema.withDecodingDefaultType(Effect.succeed(DEFAULT_CUSTOMIZATION_ID))),
+  /**
+   * @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.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.",
+    })
+  ).pipe(Schema.withDecodingDefaultType(Effect.succeed(DEFAULT_PROFILE_ID))),
+  /**
+   * @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: peppolIsoDateStringSchema,
+  /**
+   * @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(peppolIsoDateStringSchema),
+  /**
+   * @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(peppolInvoicePeriodSchema),
+  /**
+   * @summary ORDER AND SALES ORDER REFERENCE
+   *
+   * @name `cac:OrderReference`
+   */
+  orderReference: Schema.optional(peppolOrderReferenceSchema),
+  /**
+   * @summary PRECEDING INVOICE REFERENCE (0..n)
+   *
+   * @name `cac:BillingReference`
+   */
+  billingReferences: Schema.optional(Schema.Array(peppolBillingReferenceSchema)),
+  /**
+   * @summary DESPATCH ADVICE REFERENCE
+   *
+   * @name `cac:DespatchDocumentReference`
+   */
+  despatchDocumentReference: Schema.optional(
+    Schema.Struct({
+      /**
+       * @description An identifier of a referenced despatch advice.
+       *
+       * @example
+       *   `desp98`;
+       *
+       * @summary Despatch advice reference
+       *
+       * @name `cbc:ID`
+       */
+      id: Schema.String,
+    })
+  ),
+  /**
+   * @summary RECEIPT ADVICE REFERENCE
+   *
+   * @name `cac:ReceiptDocumentReference`
+   */
+  receiptDocumentReference: Schema.optional(
+    Schema.Struct({
+      /**
+       * @description An identifier of a referenced receiving advice.
+       *
+       * @example
+       *   `rec98`;
+       *
+       * @summary Receiving advice reference
+       *
+       * @name `cbc:ID`
+       */
+      id: Schema.String,
+    })
+  ),
+  /**
+   * @summary TENDER OR LOT REFERENCE
+   *
+   * @name `cac:OriginatorDocumentReference`
+   */
+  originatorDocumentReference: Schema.optional(
+    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,
+    })
+  ),
+
+  /**
+   * @summary CONTRACT REFERENCE
+   *
+   * @name `cac:ContractDocumentReference`
+   */
+  contractDocumentReference: Schema.optional(
+    Schema.Struct({
+      /**
+       * @description An identifier of a referenced contract.
+       *
+       * @example
+       *   `123Contractref`;
+       *
+       * @summary Contract reference
+       *
+       * @name `cbc:ID`
+       */
+      id: Schema.String,
+    })
+  ),
+
+  /**
+   * @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(peppolAdditionalDocumentReferenceSchema)),
+
+  /**
+   * @description A group of business terms providing information about the seller.
+   *
+   * @summary SELLER
+   *
+   * @name `cac:AccountingSupplierParty`
+   */
+  accountingSupplierParty: peppolPartyBaseSchema,
+
+  /**
+   * @description A group of business terms providing information about the Buyer.
+   *
+   * @summary BUYER
+   *
+   * @name `cac:AccountingCustomerParty`
+   */
+  accountingCustomerParty: peppolPartyBaseSchema,
+
+  /**
+   * @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(peppolPayeePartySchema),
+
+  /**
+   * @description SELLER TAX REPRESENTATIVE PARTY.
+   *
+   * @name cac:TaxRepresentativeParty
+   */
+  taxRepresentativeParty: Schema.optional(peppolTaxRepresentativeSchema),
+
+  /**
+   * @description DELIVERY INFORMATION.
+   *
+   * @name cac:Delivery
+   */
+  delivery: Schema.optional(peppolDeliverySchema),
+
+  /**
+   * @summary PAYMENT INSTRUCTIONS
+   * @summary A group of business terms providing information about the payment.
+   *
+   * @name cac:PaymentMeans
+   */
+  paymentMeans: Schema.optional(Schema.Array(peppolPaymentMeansSchema)),
+
+  /**
+   * @example
+   *   Net within 30 days
+   *
+   * @summary PAYMENT TERMS
+   *
+   * @name cac:PaymentTerms
+   */
+  paymentTerms: Schema.optional(peppolPaymentTermsSchema),
+
+  /**
+   * @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(peppolTaxTotalsBaseSchema).check(Schema.isMinLength(1), Schema.isMaxLength(2)),
+
+  /**
+   * @summary DOCUMENT TOTALS
+   *
+   * @name cac:LegalMonetaryTotal
+   */
+  legalMonetaryTotal: peppolLegalMonetaryTotalSchema,
+});
+
+export type PeppolBillingBase = typeof peppolBillingBaseSchema.Type;

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

@@ -0,0 +1,31 @@
+import { Schema } from 'effect';
+
+import { peppolCreditNoteLineSchema } from './fields/peppol-credit-note-line-schema';
+import { peppolBillingBaseSchema } from './peppol-billing-base-schema';
+import { creditNoteTypeCodeSchema } from './values/credit-note-type-code-schema';
+
+/**
+ * @description Main UBL Credit Note schema (camelCase properties) Effect port of `creditNoteSchema` (`z.extend(billingBaseSchema, ...)` →
+ * `peppolBillingBaseSchema.pipe(Schema.fieldsAssign(...))`).
+ */
+export const peppolCreditNoteSchema = peppolBillingBaseSchema.pipe(
+  Schema.fieldsAssign({
+    /**
+     * @description CREDIT NOTE LINE.
+     *
+     * @name cac:CreditNoteLine (1..n)
+     */
+    creditNoteLines: Schema.Array(peppolCreditNoteLineSchema).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(),
+  })
+);
+
+export type PeppolCreditNote = typeof peppolCreditNoteSchema.Type;

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

@@ -0,0 +1,38 @@
+import { Schema } from 'effect';
+
+import { peppolDocumentTypeCodeSchema } from './values/peppol-document-type-code-schema';
+
+export const peppolDocumentResponseDocumentReferenceSchema = 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 = typeof peppolDocumentResponseDocumentReferenceSchema.Type;

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

@@ -0,0 +1,35 @@
+import { Schema } from 'effect';
+
+import { applicationResponseTypeCodeSchema } from './values/application-response-type-code-schema';
+
+/**
+ * @summary Response information
+ *
+ * @name `cac:Response`
+ *
+ * @cardinality (1..1)
+ *
+ * @see {@link messageLevelResponseDocumentResponseSchema}
+ */
+export const peppolDocumentResponseDocumentSchema = 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 = typeof peppolDocumentResponseDocumentSchema.Type;

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

@@ -0,0 +1,44 @@
+import { Schema } from 'effect';
+
+import { applicationResponseTypeCodeSchema } from './values/application-response-type-code-schema';
+
+export const peppolDocumentResponseLineResponseContentSchema = 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: 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 type DocumentResponseLineResponseContent = typeof peppolDocumentResponseLineResponseContentSchema.Type;

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

@@ -0,0 +1,33 @@
+import { Schema } from 'effect';
+
+import { peppolDocumentResponseLineResponseContentSchema } from './peppol-document-response-line-response-content-schema';
+
+export const peppolDocumentResponseLineResponseSchema = Schema.Struct({
+  /**
+   * @description Identifies the line in the business document to which the reported issue applies.
+   *
+   * @summary Line reference
+   *
+   * @name `cac:LineReference`
+   */
+  lineReference: 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,
+  }),
+  /**
+   * @summary Line response information
+   */
+  response: peppolDocumentResponseLineResponseContentSchema,
+});
+
+export type PeppolMessageLevelDocumentResponseLineResponse = typeof peppolDocumentResponseLineResponseSchema.Type;