@endevops/peppol-schema 0.1.3 → 0.1.5

package/src/schemas/fields/peppol-line-item-schema.ts

@@ -4,9 +4,19 @@ import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema.ts';
 import { PeppolItemClassification } from '#/schemas/fields/peppol-item-classification-schema.ts';
 import { PeppolTaxCategory } from '#/schemas/fields/peppol-tax-category-schema.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { icdCodesSchema } from '#/schemas/values/icd-codes-schema.ts';
-import { peppolCountryCodeSchema } from '#/schemas/values/peppol-country-code-schema.ts';
+import { PeppolIcdCode } from '#/schemas/values/icd-codes-schema.ts';
+import { PeppolCountryCodeValue } from '#/schemas/values/peppol-country-code-schema.ts';
 
+/**
+ * @description An additional property of the item, expressed as an attribute name and value pair.
+ *
+ * @example
+ *   ```ts
+ *   { name: 'Colour', value: 'Blue' }
+ *   ```;
+ *
+ * @see {@link PeppolLineItem}
+ */
 export class PeppolAdditionalItemProperties extends opaque<PeppolAdditionalItemProperties>()(
   Schema.Struct({
     /**
@@ -28,6 +38,16 @@ export class PeppolAdditionalItemProperties extends opaque<PeppolAdditionalItemP
   })
 ) {}
 
+/**
+ * @description A code classifying the item by its type or nature, identified by a scheme such as CPV.
+ *
+ * @example
+ *   ```ts
+ *   { itemClassification: { id: '09348023', listId: 'STI' } }
+ *   ```;
+ *
+ * @see {@link PeppolItemClassification}
+ */
 export class PeppolCommodityClassifications extends opaque<PeppolCommodityClassifications>()(
   Schema.Struct({
     /**
@@ -44,6 +64,16 @@ export class PeppolCommodityClassifications extends opaque<PeppolCommodityClassi
   })
 ) {}
 
+/**
+ * @description The country from which the item originates, identified by an ISO 3166-1 country code.
+ *
+ * @example
+ *   ```ts
+ *   { identificationCode: 'NO' }
+ *   ```;
+ *
+ * @see {@link PeppolLineItem}
+ */
 export class PeppolOriginCountryCode extends opaque<PeppolOriginCountryCode>()(
   Schema.Struct({
     /**
@@ -53,10 +83,20 @@ export class PeppolOriginCountryCode extends opaque<PeppolOriginCountryCode>()(
      *
      * @name `cbc:IdentificationCode`
      */
-    identificationCode: peppolCountryCodeSchema,
+    identificationCode: PeppolCountryCodeValue,
   })
 ) {}
 
+/**
+ * @description An item identifier based on a registered scheme, such as a GTIN or EAN.
+ *
+ * @example
+ *   ```ts
+ *   { id: { id: '21382183120983', schemeId: '0088' } }
+ *   ```;
+ *
+ * @see {@link PeppolIdentifier}
+ */
 export class PeppolStandardItemIdentification extends opaque<PeppolStandardItemIdentification>()(
   Schema.Struct({
     /**
@@ -83,12 +123,22 @@ export class PeppolStandardItemIdentification extends opaque<PeppolStandardItemI
          *
          * @name `@schemeID`
          */
-        schemeId: icdCodesSchema,
+        schemeId: PeppolIcdCode,
       })
     ),
   })
 ) {}
 
+/**
+ * @description An identifier assigned by the Seller for the item.
+ *
+ * @example
+ *   ```ts
+ *   { id: '987323' }
+ *   ```;
+ *
+ * @see {@link PeppolLineItem}
+ */
 export class PeppolSellersItemIdentification extends opaque<PeppolSellersItemIdentification>()(
   Schema.Struct({
     /**
@@ -105,6 +155,16 @@ export class PeppolSellersItemIdentification extends opaque<PeppolSellersItemIde
   })
 ) {}
 
+/**
+ * @description An identifier assigned by the Buyer for the item.
+ *
+ * @example
+ *   ```ts
+ *   { id: '12345' }
+ *   ```;
+ *
+ * @see {@link PeppolLineItem}
+ */
 export class PeppolBuyersItemIdentification extends opaque<PeppolBuyersItemIdentification>()(
   Schema.Struct({
     /**
@@ -122,6 +182,8 @@ export class PeppolBuyersItemIdentification extends opaque<PeppolBuyersItemIdent
 ) {}
 
 /**
+ * @description The item details for an invoice or credit note line, including its name, identifiers, classification, and line VAT category.
+ *
  * @summary Item details on invoice/credit-note line
  *
  * @name cac:Item
@@ -192,5 +254,3 @@ export class PeppolLineItem extends opaque<PeppolLineItem>()(
     additionalItemProperties: Schema.optional(Schema.Array(PeppolAdditionalItemProperties)),
   })
 ) {}
-
-export type PeppolItem = PeppolLineItem;

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

@@ -3,6 +3,16 @@ import { Schema } from 'effect';
 import { PeppolAmount } from '#/schemas/fields/peppol-amount-schema.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
 
+/**
+ * @description A price level allowance or charge applied to the item price, expressed as an amount and a charge indicator.
+ *
+ * @example
+ *   ```ts
+ *   { amount: { value: 200, currencyId: 'EUR' }, chargeIndicator: false }
+ *   ```;
+ *
+ * @see {@link PeppolLinePriceAllowanceCharge}
+ */
 class PriceAllowanceCharge extends opaque<PriceAllowanceCharge>()(
   Schema.Struct({
     /**
@@ -28,6 +38,16 @@ class PriceAllowanceCharge extends opaque<PriceAllowanceCharge>()(
   })
 ) {}
 
+/**
+ * @description A price level allowance on the item price. Only allowances are allowed at price level, so the charge indicator is fixed to false.
+ *
+ * @example
+ *   ```ts
+ *   { amount: { value: 200, currencyId: 'EUR' }, chargeIndicator: false }
+ *   ```;
+ *
+ * @see {@link PeppolLinePrice}
+ */
 export class PeppolLinePriceAllowanceCharge extends opaque<PeppolLinePriceAllowanceCharge>()(
   PriceAllowanceCharge.pipe(
     Schema.fieldsAssign({

package/src/schemas/fields/peppol-line-price-schema.ts

@@ -6,6 +6,8 @@ import { PeppolQuantity } from '#/schemas/fields/peppol-quantity-schema.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
 
 /**
+ * @description The price details of an invoice or credit note line, including the price amount and any price level allowance.
+ *
  * @summary Price details on invoice line
  *
  * @name cac:Price

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

@@ -3,6 +3,8 @@ import { Schema } from 'effect';
 import { opaque } from '#/schemas/utils/opaque.ts';
 
 /**
+ * @description A reference to the purchase order or sales order that the invoice relates to.
+ *
  * @summary ORDER AND SALES ORDER REFERENCE
  *
  * @name cac:OrderReference

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

@@ -6,9 +6,19 @@ import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema.ts';
 import { PeppolPartyLegalEntity } from '#/schemas/fields/peppol-party-legal-entity-schema.ts';
 import { PeppolPartyTaxScheme } from '#/schemas/fields/peppol-party-tax-scheme-schema.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
-import { electronicCodesSchema } from '#/schemas/values/electronic-codes-schema.ts';
-import { icdCodesSchema } from '#/schemas/values/icd-codes-schema.ts';
+import { PeppolElectronicAddressCode } from '#/schemas/values/electronic-codes-schema.ts';
+import { PeppolIcdCode } from '#/schemas/values/icd-codes-schema.ts';
 
+/**
+ * @description A name by which the Buyer or Seller is known, other than its registered name.
+ *
+ * @example
+ *   ```ts
+ *   { name: 'SupplierTradingName Ltd.' }
+ *   ```;
+ *
+ * @see {@link PeppolPartySchema}
+ */
 export class PeppolPartyName extends opaque<PeppolPartyName>()(
   Schema.Struct({
     /**
@@ -23,6 +33,16 @@ export class PeppolPartyName extends opaque<PeppolPartyName>()(
   })
 ) {}
 
+/**
+ * @description An identifier of the Buyer or Seller, with an optional identification scheme.
+ *
+ * @example
+ *   ```ts
+ *   { id: { id: '99887766', schemeId: '0088' } }
+ *   ```;
+ *
+ * @see {@link PeppolPartySchema}
+ */
 export class PeppolPartyIdentification extends opaque<PeppolPartyIdentification>()(
   Schema.Struct({
     /**
@@ -52,12 +72,22 @@ export class PeppolPartyIdentification extends opaque<PeppolPartyIdentification>
          *
          * @name `@schemeID`
          */
-        schemeId: Schema.optional(icdCodesSchema),
+        schemeId: Schema.optional(PeppolIcdCode),
       })
     ),
   })
 ) {}
 
+/**
+ * @description The Buyer or Seller electronic address to which the application level response to the invoice may be delivered.
+ *
+ * @example
+ *   ```ts
+ *   { id: '9482348239847239874', schemeId: '0088' }
+ *   ```;
+ *
+ * @see {@link PeppolPartySchema}
+ */
 export class PeppolPartyEndpointId extends opaque<PeppolPartyEndpointId>()(
   PeppolIdentifier.pipe(
     Schema.fieldsAssign({
@@ -79,12 +109,14 @@ export class PeppolPartyEndpointId extends opaque<PeppolPartyEndpointId>()(
        *
        * @name `@schemeID`
        */
-      schemeId: electronicCodesSchema,
+      schemeId: PeppolElectronicAddressCode,
     })
   )
 ) {}
 
 /**
+ * @description The common party substructure shared by the supplier, customer, and other party roles.
+ *
  * @summary Party common substructure
  *
  * @name cac:Party

package/src/schemas/fields/peppol-party-legal-entity-schema.ts

@@ -3,6 +3,16 @@ import { Schema } from 'effect';
 import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema.ts';
 import { opaque } from '#/schemas/utils/opaque.ts';
 
+/**
+ * @description The legal entity details of a party, including the registered name and optional company identifiers.
+ *
+ * @example
+ *   ```ts
+ *   { registrationName: 'SupplierOfficialName Ltd', companyId: { id: 'GB983294' } }
+ *   ```;
+ *
+ * @see {@link PeppolPartySchema}
+ */
 export class PeppolPartyLegalEntity extends opaque<PeppolPartyLegalEntity>()(
   Schema.Struct({
     /**
@@ -28,5 +38,3 @@ export class PeppolPartyLegalEntity extends opaque<PeppolPartyLegalEntity>()(
     registrationName: Schema.String,
   })
 ) {}
-
-export type PeppolPartyLegalEntitySchema = PeppolPartyLegalEntity;

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

@@ -2,7 +2,7 @@ import { Effect, Schema } from 'effect';
 
 import { opaque } from '#/schemas/utils/opaque.ts';
 
-class PeppolTaxSchemeId extends opaque<PeppolTaxSchemeId>()(
+export class PeppolPartyTaxSchemeId extends opaque<PeppolPartyTaxSchemeId>()(
   Schema.Struct({
     /**
      * @description Mandatory element. For Seller VAT identifier (BT-31), use value “VAT”, for the seller tax registration identifier (BT-32), use != "VAT"
@@ -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>()(
@@ -34,8 +36,6 @@ export class PeppolPartyTaxScheme extends opaque<PeppolPartyTaxScheme>()(
      *
      * @name `cac:TaxScheme`
      */
-    taxSchemeId: PeppolTaxSchemeId,
+    taxSchemeId: PeppolPartyTaxSchemeId,
   })
 ) {}
-
-export type PeppolPartyTaxSchema = PeppolPartyTaxScheme;

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

@@ -2,11 +2,11 @@ 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 })) {}
+export class PeppolPayeePartyName extends opaque<PeppolPayeePartyName>()(Schema.Struct({ name: Schema.String })) {}
 
-class PeppolPartyLegalEntity extends opaque<PeppolPartyLegalEntity>()(
+export class PeppolPayeePartyLegalEntity extends opaque<PeppolPayeePartyLegalEntity>()(
   Schema.Struct({
     /**
      * @description An identifier issued by an official registrar that identifies the payee as a legal entity or person.
@@ -39,14 +39,14 @@ class PeppolPartyLegalEntity extends opaque<PeppolPartyLegalEntity>()(
            *
            * @name `@schemeID`
            */
-          schemeId: Schema.optional(icdCodesSchema),
+          schemeId: Schema.optional(PeppolIcdCode),
         })
       )
     ),
   })
 ) {}
 
-class PeppolPartyIdentification extends opaque<PeppolPartyIdentification>()(
+export class PeppolPayeePartyIdentification extends opaque<PeppolPayeePartyIdentification>()(
   Schema.Struct({
     /**
      * @description This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee
@@ -97,13 +97,13 @@ export class PeppolPayeeParty extends opaque<PeppolPayeeParty>()(
      *
      * @name `cac:PartyIdentification`
      */
-    partyIdentification: Schema.optional(PeppolPartyIdentification),
+    partyIdentification: Schema.optional(PeppolPayeePartyIdentification),
     /**
      * @summary PARTY LEGAL ENTITY
      *
      * @name `cac:PartyLegalEntity`
      */
-    partyLegalEntity: Schema.optional(PeppolPartyLegalEntity),
+    partyLegalEntity: Schema.optional(PeppolPayeePartyLegalEntity),
     /**
      * @description The name of the payee.
      *
@@ -114,6 +114,6 @@ export class PeppolPayeeParty extends opaque<PeppolPayeeParty>()(
      *
      * @name `cac:PartyName`
      */
-    partyName: PeppolPartyName,
+    partyName: PeppolPayeePartyName,
   })
 ) {}

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
@@ -22,5 +24,3 @@ export class PeppolTaxRepresentative extends opaque<PeppolTaxRepresentative>()(
     partyTaxScheme: PeppolPartyTaxScheme,
   })
 ) {}
-
-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,11 +5,13 @@ 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)
  */
-export class PeppolTaxTotalsBase extends opaque<PeppolTaxTotalsBase>()(
+export class PeppolTaxTotal extends opaque<PeppolTaxTotal>()(
   Schema.Struct({
     /**
      * @example
@@ -24,5 +26,3 @@ export class PeppolTaxTotalsBase extends opaque<PeppolTaxTotalsBase>()(
     taxSubtotals: Schema.optional(Schema.Array(PeppolTaxSubTotal)),
   })
 ) {}
-
-export type PeppolTaxTotal = PeppolTaxTotalsBase;