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

package/src/decoders/fields/encode-message-party.ts

@@ -1,14 +1,14 @@
 import { Effect, Predicate } from 'effect';
 
-import type { InvoiceDocumentResponseParty, InvoiceResponseParty } from '#/schemas/invoice-response-schema';
-import type { PeppolMessageLevelResponseParty } from '#/schemas/message-level-response-party-schema';
+import type { PeppolInvoiceDocumentResponseParty, PeppolInvoiceResponseParty } from '#/schemas/peppol-invoice-response-schema';
+import type { PeppolMessageLevelResponseParty } from '#/schemas/peppol-message-level-response-party-schema';
 
 import { encodeContact } from '#/decoders/fields/encode-contact';
 import { encodeIdentifier } from '#/decoders/fields/encode-identifier';
 import { encodePartyLegalEntity } from '#/decoders/fields/encode-party-legal-entity';
 
 export const encodeMessageParty = Effect.fn(function* (
-  party?: PeppolMessageLevelResponseParty | InvoiceResponseParty | InvoiceDocumentResponseParty
+  party?: PeppolMessageLevelResponseParty | PeppolInvoiceResponseParty | PeppolInvoiceDocumentResponseParty
 ) {
   if (Predicate.isNullish(party)) return undefined;
   return {

package/src/decoders/fields/encode-order-reference.ts

@@ -1,6 +1,6 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolOrderReference } from '#/schemas/fields/order-reference-schema';
+import type { PeppolOrderReference } from '#/schemas/fields/peppol-order-reference-schema';
 
 export const encodeOrderReference = Effect.fn(function* (orderReference: PeppolOrderReference | undefined) {
   if (Predicate.isNullish(orderReference)) return undefined;

package/src/decoders/fields/encode-parties-tax-scheme.ts

@@ -1,7 +1,7 @@
 import { Effect, Predicate } from 'effect';
 
 import type { XmlNode } from '#/helpers/get-prop';
-import type { PeppolPartyTaxSchema } from '#/schemas/fields/party-tax-schema';
+import type { PeppolPartyTaxSchema } from '#/schemas/fields/peppol-party-tax-scheme-schema';
 
 import { encodePartyTaxScheme } from '#/decoders/fields/encode-party-tax-scheme';
 

package/src/decoders/fields/encode-party-tax-scheme.ts

@@ -1,7 +1,7 @@
 import { Effect, Predicate } from 'effect';
 
 import type { XmlNode } from '#/helpers/get-prop';
-import type { PeppolPartyTaxSchema } from '#/schemas/fields/party-tax-schema';
+import type { PeppolPartyTaxSchema } from '#/schemas/fields/peppol-party-tax-scheme-schema';
 
 import { encodeSimpleIdentifier } from '#/decoders/fields/encode-simple-identifier';
 

package/src/decoders/fields/encode-party.ts

@@ -1,6 +1,6 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolPartySchema } from '#/schemas/fields/party-base-schema';
+import type { PeppolPartySchema } from '#/schemas/fields/peppol-party-base-schema';
 
 import { encodeAddress } from '#/decoders/fields/encode-address';
 import { encodeContact } from '#/decoders/fields/encode-contact';

package/src/decoders/fields/encode-payee-party.ts

@@ -1,6 +1,6 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolPayeeParty } from '#/schemas/fields/payee-party';
+import type { PeppolPayeeParty } from '#/schemas/fields/peppol-payee-party-schema';
 
 import { encodeIdentifier } from '#/decoders/fields/encode-identifier';
 

package/src/decoders/fields/encode-payment-means.ts

@@ -1,10 +1,10 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolPaymentMeans } from '#/schemas/fields/payment-means-schema';
+import type { PeppolPaymentMeans } from '#/schemas/fields/peppol-payment-means-schema';
 
 import { encodeSimpleIdentifier } from '#/decoders/fields/encode-simple-identifier';
 
-export const encodePaymentMeans = Effect.fn(function* (pms: Array<PeppolPaymentMeans> | undefined) {
+export const encodePaymentMeans = Effect.fn(function* (pms: ReadonlyArray<PeppolPaymentMeans> | undefined) {
   if (Predicate.isNullish(pms)) return undefined;
 
   return yield* Effect.forEach(

package/src/decoders/fields/encode-payment-terms.ts

@@ -1,6 +1,6 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolPaymentTerms } from '#/schemas/fields/payment-terms-schema';
+import type { PeppolPaymentTerms } from '#/schemas/fields/peppol-payment-terms-schema';
 
 export const encodePaymentTerms = Effect.fn(function* (paymentTerms: PeppolPaymentTerms | undefined) {
   if (Predicate.isNullish(paymentTerms)) return undefined;

package/src/decoders/fields/encode-price-allowance-charges.ts

@@ -1,6 +1,6 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolLinePriceAllowanceCharge } from '#/schemas/fields/line-price-allowance-charge-schema';
+import type { PeppolLinePriceAllowanceCharge } from '#/schemas/fields/peppol-line-price-allowance-charge-schema';
 
 import { encodeAmount } from '#/decoders/fields/encode-amount';
 

package/src/decoders/fields/encode-quantity.ts

@@ -1,6 +1,6 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolQuantity } from '#/schemas/fields/quantity-schema';
+import type { PeppolQuantity } from '#/schemas/fields/peppol-quantity-schema';
 
 export const encodeQuantity = Effect.fn(function* (quantity?: PeppolQuantity) {
   if (Predicate.isNullish(quantity)) return undefined;

package/src/decoders/fields/encode-tax-category.ts

@@ -1,6 +1,6 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolAllowanceCharge } from '#/schemas/fields/allowance-charge-schema';
+import type { PeppolAllowanceCharge } from '#/schemas/fields/peppol-allowance-charge-schema';
 
 import { encodeSimpleIdentifier } from '#/decoders/fields/encode-simple-identifier';
 

package/src/decoders/fields/encode-tax-representative-party.ts

@@ -1,7 +1,7 @@
 import { Effect, Predicate } from 'effect';
 
 import type { XmlNode } from '#/helpers/get-prop';
-import type { PeppolTaxRepresentativeParty } from '#/schemas/fields/tax-representative-party-schema';
+import type { PeppolTaxRepresentativeParty } from '#/schemas/fields/peppol-tax-representative-schema';
 
 import { encodeAddress } from '#/decoders/fields/encode-address';
 import { encodePartyTaxScheme } from '#/decoders/fields/encode-party-tax-scheme';

package/src/decoders/fields/encode-tax-totals.ts

@@ -1,12 +1,12 @@
 import { Effect, Predicate } from 'effect';
 
-import type { PeppolTaxSubTotal } from '#/schemas/fields/tax-subtotal-schema';
-import type { PeppolTaxTotal } from '#/schemas/fields/tax-totals';
+import type { PeppolTaxSubTotal } from '#/schemas/fields/peppol-tax-subtotal-schema';
+import type { PeppolTaxTotal } from '#/schemas/fields/peppol-tax-totals-base-schema';
 
 import { encodeAmount } from '#/decoders/fields/encode-amount';
 import { encodeSimpleIdentifier } from '#/decoders/fields/encode-simple-identifier';
 
-export const encodeTaxTotals = Effect.fn(function* (taxTotals: Array<PeppolTaxTotal>) {
+export const encodeTaxTotals = Effect.fn(function* (taxTotals: ReadonlyArray<PeppolTaxTotal>) {
   return yield* Effect.forEach(
     taxTotals,
     Effect.fn(function* (taxTotal: PeppolTaxTotal) {
@@ -15,7 +15,7 @@ export const encodeTaxTotals = Effect.fn(function* (taxTotals: Array<PeppolTaxTo
   );
 });
 
-const encodeTaxSubtotals = Effect.fn(function* (taxSubtotals: Array<PeppolTaxSubTotal> | undefined) {
+const encodeTaxSubtotals = Effect.fn(function* (taxSubtotals: ReadonlyArray<PeppolTaxSubTotal> | undefined) {
   if (Predicate.isNullish(taxSubtotals)) return undefined;
 
   return yield* Effect.forEach(

package/src/helpers/bool.ts

@@ -1,20 +1,17 @@
-import { Effect, Predicate } from 'effect';
+import { Effect, Predicate, SchemaIssue } from 'effect';
 
 import type { XmlNode } from '#/helpers/get-prop';
 
-import { PeppolNodeError } from '#/helpers/errors';
 import { getProp } from '#/helpers/get-prop';
-import { isDefined } from '#/helpers/is-defined';
 
-export const bool = Effect.fn(function* <const T extends boolean = boolean>(
-  node: XmlNode,
-  ...path: Array<string>
-): Effect.fn.Return<T, PeppolNodeError> {
-  const val = yield* getProp(node, ...path);
-  if (!isDefined(val)) {
-    return yield* new PeppolNodeError({ message: `Unable to find ${path.join('->')} into ${node}` });
-  }
+export const bool = Effect.fn(function* <const T extends boolean = boolean>(node: XmlNode, ...path: Array<string>) {
+  const val = yield* getProp(node, ...path).pipe(
+    Effect.filterOrFail(
+      val => Predicate.isNotNullish(val),
+      () => new SchemaIssue.MissingKey({ message: `Unable to find ${path.join('->')} into ${node}` })
+    )
+  );
   if (Predicate.isBoolean(val)) return val as T;
   if (Predicate.isObject(val) && Predicate.hasProperty(val, '#text') && Predicate.isNotUndefined(val['#text'])) return val['#text'] as T;
-  return yield* new PeppolNodeError({ message: `Unable to find ${path.join('->')} into ${node}` });
+  return yield* Effect.fail(new SchemaIssue.MissingKey({ message: `Unable to find ${path.join('->')} into ${node}` }));
 });

package/src/helpers/get-prop.ts

@@ -1,7 +1,5 @@
 import { Effect, Predicate } from 'effect';
 
-import { isDefined } from '#/helpers/is-defined';
-
 // oxlint-disable-next-line typescript/no-explicit-any
 export type XmlNode = any;
 
@@ -15,14 +13,14 @@ export const getProp = Effect.fn(function* (node: XmlNode, ...path: Array<string
   let currentNode = node;
   for (const key of path) {
     const newNode = currentNode[key];
-    if (isDefined(newNode)) {
+    if (Predicate.isNotNullish(newNode)) {
       currentNode = newNode;
       continue;
     }
     if (key.includes(':')) {
       const [, localKey] = key.split(':') as [string, string, ...Array<string>];
       currentNode = currentNode[localKey];
-      if (!isDefined(currentNode)) {
+      if (Predicate.isNullish(currentNode)) {
         return undefined;
       }
     } else {

package/src/helpers/str-or-und.ts

@@ -3,15 +3,14 @@ import { Effect, Predicate } from 'effect';
 import type { XmlNode } from '#/helpers/get-prop';
 
 import { getProp } from '#/helpers/get-prop';
-import { isDefined } from '#/helpers/is-defined';
 
-export const strOrUnd = Effect.fn(function* <const T extends string = string>(
+export const strOrUnd = Effect.fn('str-or-und')(function* <const T extends string = string>(
   node: XmlNode,
   ...path: Array<string>
 ): Effect.fn.Return<T | undefined> {
   const val = yield* getProp(node, ...path);
-  if (!isDefined(val)) return undefined;
-  if (!Predicate.isObject(val)) return val.toString();
+  if (Predicate.isNullish(val)) return undefined;
+  if (!Predicate.isObject(val)) return (val as { toString(): T }).toString();
   const raw = val as XmlNode;
   if (Predicate.isUndefined(raw['#text'])) return undefined;
   return raw['#text'].toString();

package/src/helpers/str.ts

@@ -1,14 +1,18 @@
-import { Effect, Predicate } from 'effect';
+import { Effect, Predicate, SchemaIssue } from 'effect';
 
 import type { XmlNode } from '#/helpers/get-prop';
 
-import { PeppolNodeError } from '#/helpers/errors';
 import { strOrUnd } from '#/helpers/str-or-und';
 
-export const str = Effect.fn(function* (node: XmlNode, ...path: Array<string>): Effect.fn.Return<string, PeppolNodeError> {
-  const val = yield* strOrUnd(node, ...path);
-  if (Predicate.isNullish(val)) {
-    return yield* new PeppolNodeError({ message: 'Invalid node' });
-  }
-  return val;
+export const str = Effect.fn(function* (node: XmlNode, ...path: Array<string>) {
+  return yield* strOrUnd(node, ...path).pipe(
+    Effect.filterOrFail(
+      val => Predicate.isNotNullish(val),
+      () => new SchemaIssue.MissingKey({ message: `Unable to find ${path.join('->')} into ${node}` })
+    ),
+    Effect.filterOrFail(
+      val => Predicate.isString(val),
+      () => new SchemaIssue.InvalidValue({ message: `Invalid node ${path.join('->')} into ${node}` })
+    )
+  );
 });

package/src/index.ts

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

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

@@ -0,0 +1,123 @@
+import { Schema } from 'effect';
+
+import { PeppolBinaryObject } from '#/schemas/fields/peppol-binary-object-schema';
+import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema';
+import { opaque } from '#/schemas/utils/opaque';
+import { additionalDocumentReferenceCodeSchema } from '#/schemas/values/additional-document-reference-code-schema';
+
+class PeppolAttachmentExternalReference extends opaque<PeppolAttachmentExternalReference>()(
+  Schema.Struct({
+    /**
+     * @description The URL (Uniform Resource Locator) that identifies where the external document is located. A means of locating the resource, including its
+     * primary access mechanism, e.g. http:// or ftp://.
+     *
+     * @example
+     *   `http://www.example.com/index.html`;
+     *
+     * @summary External document location
+     *
+     * @name `cbc:URI`
+     */
+    uri: Schema.String,
+  })
+) {}
+
+class PeppolAttachment extends opaque<PeppolAttachment>()(
+  Schema.Struct({
+    /**
+     * @description An attached document embedded as binary object (Base64) or sent together with the invoice.
+     *
+     * @example
+     *   ```base64
+     *   aHR0cHM6Ly90ZXN0LXZlZmEuZGlmaS5uby9wZXBwb2xiaXMvcG9hY2MvYmlsbGluZy8zLjAvYmlzLw==
+     *   ```;
+     *
+     * @summary Attached document
+     *
+     * @name `cbc:EmbeddedDocumentBinaryObject`
+     */
+    embeddedDocumentBinaryObject: Schema.optional(PeppolBinaryObject),
+    /**
+     * @summary EXTERNAL REFERENCE
+     *
+     * @name `cac:ExternalReference`
+     */
+    externalReference: Schema.optional(PeppolAttachmentExternalReference),
+  })
+) {}
+
+class PeppolId extends opaque<PeppolId>()(
+  Schema.Struct({
+    /**
+     * @description An identifier for an object on which the invoice is based (with DocumentTypeCode=130), given by the Seller, the identifier for the supporting
+     * document or the project reference identifier (DocumentTypeCode=50).
+     *
+     * @summary Invoiced object identifier, Supporting document reference or project reference
+     *
+     * @name `#text`
+     */
+    id: Schema.String,
+    /**
+     * @description The identification scheme identifier of the Invoiced object identifier.
+     *
+     * @summary Scheme identifier
+     *
+     * @name `@schemeID`
+     */
+    schemeId: Schema.optional(additionalDocumentReferenceCodeSchema),
+  })
+) {}
+
+/**
+ * @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`
+ */
+export class PeppolAdditionalDocumentReference extends opaque<PeppolAdditionalDocumentReference>()(
+  PeppolIdentifier.pipe(
+    Schema.fieldsAssign({
+      /**
+       * @description An identifier for an object on which the invoice is based (with DocumentTypeCode=130), given by the Seller, the identifier for the supporting
+       * document or the project reference identifier (DocumentTypeCode=50).
+       *
+       * @summary Invoiced object identifier, Supporting document reference or project reference
+       *
+       * @name `cbc:ID`
+       */
+      id: PeppolId,
+      /**
+       * @remarks
+       *   Code "130" MUST be used to indicate an invoice object reference and code "50" for project reference. Element is not used for other
+       *   additional documents.
+       *
+       * @default 130
+       *
+       * @summary Document type code
+       *
+       * @name `cbc:DocumentTypeCode`
+       */
+      documentTypeCode: Schema.optional(Schema.String),
+      /**
+       * @description A description of the supporting document, such as timesheet, usage report, etc.
+       *
+       * @example
+       *   Time list
+       *
+       * @summary Supporting document description
+       *
+       * @name `cbc:DocumentDescription`
+       */
+      documentDescription: Schema.optional(Schema.String),
+      /**
+       * @summary Attachment
+       *
+       * @name `cac:Attachment`
+       */
+      attachment: Schema.optional(PeppolAttachment),
+    })
+  )
+) {}

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

@@ -0,0 +1,112 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+import { peppolCountryCodeSchema } from '#/schemas/values/peppol-country-code-schema';
+
+class PeppolAddressLine extends opaque<PeppolAddressLine>()(
+  Schema.Struct({
+    /**
+     * @description An additional address line in an address that can be used to give further details supplementing the main line.
+     *
+     * @summary Address line 3
+     *
+     * @name `cbc:Line`
+     */
+    line: Schema.String,
+  })
+) {}
+
+class PeppolCountryCode extends opaque<PeppolCountryCode>()(
+  Schema.Struct({
+    /**
+     * @description A code that identifies the country.
+     *
+     * @example
+     *   GB;
+     *
+     * @summary Country code
+     *
+     * @name `cbc:IdentificationCode`
+     */
+    identificationCode: peppolCountryCodeSchema,
+  })
+) {}
+
+/**
+ * @summary Postal address
+ *
+ * @name `cac:PostalAddress`
+ */
+export class PeppolAddress extends opaque<PeppolAddress>()(
+  Schema.Struct({
+    /**
+     * @description The main address line in an address.
+     *
+     * @example
+     *   Main Street 1
+     *
+     * @summary Address line 1
+     *
+     * @name `cbc:StreetName`
+     */
+    streetName: Schema.optional(Schema.String),
+    /**
+     * @description An additional address line in an address that can be used to give further details supplementing the main line.
+     *
+     * @example
+     *   Po Box 351
+     *
+     * @summary Address line 2
+     *
+     * @name `cbc:AdditionalStreetName`
+     */
+    additionalStreetName: Schema.optional(Schema.String),
+    /**
+     * @description The common name of the city, town or village, where the address is located.
+     *
+     * @example
+     *   London;
+     *
+     * @summary Seller city
+     *
+     * @name `cbc:CityName`
+     */
+    cityName: Schema.optional(Schema.String),
+    /**
+     * @description The identifier for an addressable group of properties according to the relevant postal service.
+     *
+     * @example
+     *   W1G 8LZ
+     *
+     * @summary post code
+     *
+     * @name `cbc:PostalZone`
+     */
+    postalZone: Schema.optional(Schema.String),
+    /**
+     * @description The subdivision of a country.
+     *
+     * @example
+     *   Region A
+     *
+     * @summary Seller country subdivision
+     *
+     * @name `cbc:CountrySubentity`
+     */
+    countrySubentity: Schema.optional(Schema.String),
+    /**
+     * @example
+     *   GB;
+     *
+     * @name `cac:Country`
+     */
+    countryCode: PeppolCountryCode,
+    /**
+     * @example
+     *   Building 23
+     *
+     * @name `cac:AddressLine`
+     */
+    addressLine: Schema.optional(PeppolAddressLine),
+  })
+) {}

package/src/schemas/fields/peppol-allowance-charge-schema.ts

@@ -0,0 +1,104 @@
+import { Effect, Schema } from 'effect';
+
+import { BaseLineAllowanceCharge } from '#/schemas/fields/peppol-line-allowance-charge-schema';
+import { PeppolTaxCategory } from '#/schemas/fields/peppol-tax-category-schema';
+import { opaque } from '#/schemas/utils/opaque';
+import { allowanceChargeReasonCodeSchema } from '#/schemas/values/allowance-charge-reason-code-schema';
+import { chargeReasonCodeSchema } from '#/schemas/values/charge-reason-code-schema';
+import { peppolDutyTaxFeeCategorySchema } from '#/schemas/values/duty-tax-fee-category-schema';
+
+export class PeppolTaxCategoryTaxSchemeId extends opaque<PeppolTaxCategoryTaxSchemeId>()(
+  Schema.Struct({
+    /**
+     * @description Mandatory element. Use "VAT"
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('VAT'))),
+  })
+) {}
+
+export class BaseAllowanceCharge extends opaque<BaseAllowanceCharge>()(
+  Schema.Struct({
+    ...BaseLineAllowanceCharge.fields,
+    /**
+     * @summary TAX CATEGORY
+     *
+     * @name cac:TaxCategory
+     */
+    taxCategory: Schema.optional(
+      PeppolTaxCategory.pipe(
+        Schema.fieldsAssign({
+          /**
+           * @description A coded identification of what VAT category applies to the document level allowance or charge.
+           *
+           * @summary Document level allowance or charge VAT category code
+           *
+           * @name `cbc:ID`
+           */
+          id: peppolDutyTaxFeeCategorySchema,
+          /**
+           * @description The VAT rate, represented as percentage that applies to the document level allowance or charge.
+           *
+           * @summary Document level allowance or charge VAT rate
+           *
+           * @name `cbc:Percent`
+           */
+          percent: Schema.optional(Schema.Finite),
+          /**
+           * @default VAT
+           *
+           * @name `cac:TaxScheme`
+           */
+          taxSchemeId: PeppolTaxCategoryTaxSchemeId,
+        })
+      )
+    ),
+  })
+) {}
+
+export class PeppolAllowance extends opaque<PeppolAllowance>()(
+  Schema.Struct({
+    ...BaseAllowanceCharge.fields,
+    /**
+     * @name cbc:AllowanceChargeReasonCode
+     */
+    allowanceChargeReasonCode: Schema.optional(allowanceChargeReasonCodeSchema),
+    /**
+     * @name cbc:ChargeIndicator
+     *
+     * @value `false`
+     */
+    chargeIndicator: Schema.Literal(false).annotate({
+      message: "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'",
+    }),
+  })
+) {}
+
+export class PeppolCharge extends opaque<PeppolCharge>()(
+  Schema.Struct({
+    ...BaseAllowanceCharge.fields,
+    /**
+     * @name cbc:AllowanceChargeReasonCode
+     */
+    allowanceChargeReasonCode: Schema.optional(chargeReasonCodeSchema),
+    /**
+     * @name cbc:ChargeIndicator
+     *
+     * @value `true`
+     */
+    chargeIndicator: Schema.Literal(true).annotate({
+      message: "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'",
+    }),
+  })
+) {}
+
+/**
+ * @summary Allowance/Charge
+ *
+ * @name cac:AllowanceCharge
+ */
+export const peppolAllowanceChargeSchema = Schema.Union([PeppolAllowance, PeppolCharge]).annotate({ message: 'unable to decode allowance charge' });
+
+export type PeppolAllowanceCharge = Schema.Schema.Type<typeof peppolAllowanceChargeSchema>;
+export type PeppolAllowanceChargeEncoded = Schema.Codec.Encoded<typeof peppolAllowanceChargeSchema>;