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

package/src/effect/fields/delivery-schema.ts

@@ -0,0 +1,100 @@
+import { Schema } from 'effect';
+
+import { IsoDateString } from '#/effect/iso-date-string';
+import { icdCodesSchema } from '#/effect/values/icd-codes';
+
+import { addressSchema } from './address-schema';
+import { identifierSchema } from './identifier-schema';
+
+export const deliverySchema = Schema.Struct({
+  /**
+   * @description Th edate on which the supply of goods or services was made or completed.
+   *
+   * @example
+   *   2017 - 12 - 01;
+   *
+   * @summary Actual delivery date
+   *
+   * @format `YYYY-MM-DD`
+   *
+   * @name cbc:ActualDeliveryDate
+   */
+  actualDeliveryDate: Schema.optional(IsoDateString),
+  /**
+   * @name `cac:DeliveryLocation`
+   */
+  deliveryLocation: Schema.optional(
+    Schema.Struct({
+      /**
+       * @description An identifier for the location at which the goods and services are delivered.
+       *
+       * @example
+       *   `83745498753497`;
+       *
+       * @summary Deliver to location identifier
+       *
+       * @name `cbc:ID`
+       */
+      id: Schema.optional(
+        identifierSchema().pipe(
+          Schema.fieldsAssign({
+            /**
+             * @description An identifier for the location at which the goods and services are delivered.
+             *
+             * @example
+             *   `83745498753497`;
+             *
+             * @summary Deliver to location identifier
+             *
+             * @name `#text`
+             */
+            id: Schema.String,
+            /**
+             * @description The identification scheme identifier of the Deliver to location identifier.
+             *
+             * @summary Deliver to location identifier identification scheme identifier
+             *
+             * @name `@schemeID`
+             */
+            schemeId: Schema.optional(icdCodesSchema()),
+          })
+        )
+      ),
+      /**
+       * @description A groupd of business terms providing infomation about the address to which goods and services invoiced were or are delivered.
+       *
+       * @summary Deliver to address
+       *
+       * @name `cac:Address`
+       */
+      address: Schema.optional(addressSchema),
+    })
+  ),
+
+  /**
+   * @summary Delivery party
+   *
+   * @name `cac:DeliveryParty`
+   */
+  deliveryParty: Schema.optional(
+    Schema.Struct({
+      /**
+       * @summary PARTY NAME
+       *
+       * @name `cac:PartyName`
+       */
+      partyName: Schema.Struct({
+        /**
+         * @description The name of the party to which the goods and services are delivered.
+         *
+         * @summary Deliver to party name
+         *
+         * @name `cbc:Name`
+         */
+        name: Schema.String,
+      }),
+    })
+  ),
+});
+
+export type PeppolDelivery = typeof deliverySchema.Type;

package/src/effect/fields/identifier-schema.ts

@@ -0,0 +1,23 @@
+import { Schema } from 'effect';
+
+const identifierBase = Schema.Struct({
+  /**
+   * @name cbc:ID
+   */
+  id: Schema.String,
+  /**
+   * @name `@schemeID`
+   */
+  schemeId: Schema.optional(Schema.String),
+});
+
+/**
+ * @summary Identifier with optional scheme
+ *
+ * @name `cbc:ID (+ optional @schemeID)`
+ */
+export function identifierSchema(error?: string) {
+  return error === undefined ? identifierBase : identifierBase.annotate({ message: error });
+}
+
+export type PeppolIdentifier = typeof identifierBase.Type;

package/src/effect/fields/invoice-line-period-schema.ts

@@ -0,0 +1,34 @@
+import { Schema } from 'effect';
+
+import { IsoDateString } from '#/effect/iso-date-string';
+
+export const invoiceLinePeriodSchema = Schema.Struct({
+  /**
+   * @description The date when the Invoice period for this Invoice line ends. Format ="YYYY-MM-DD"
+   *
+   * @example
+   *   `2017-10-31`;
+   *
+   * @summary Invoice line period end date
+   *
+   * @format "YYYY-MM-DD"
+   *
+   * @name `cbc:EndDate`
+   */
+  endDate: Schema.optional(IsoDateString),
+  /**
+   * @description The date when the Invoice period for this Invoice line starts.
+   *
+   * @example
+   *   `2017-10-01`;
+   *
+   * @summary Invoice line period start date
+   *
+   * @format "YYYY-MM-DD"
+   *
+   * @name `cbc:StartDate`
+   */
+  startDate: Schema.optional(IsoDateString),
+});
+
+export type PeppolInvoiceLinePeriod = typeof invoiceLinePeriodSchema.Type;

package/src/effect/fields/invoice-line-schema.ts

@@ -0,0 +1,46 @@
+import { Schema } from 'effect';
+
+import { quantityUnitCodesSchema } from '#/effect/values/quantity-unit-codes-schema';
+
+import { baseLineSchema } from './base-line-schema';
+import { quantitySchema } from './quantity-schema';
+
+/**
+ * @summary Invoice line
+ *
+ * @name cac:InvoiceLine
+ */
+export const invoiceLineSchema = baseLineSchema.pipe(
+  Schema.fieldsAssign({
+    /**
+     * @description The quantity of items (goods or services) that is charged in the Invoice line.
+     *
+     * @example
+     *   { value: 100, unitCode: "C62" }
+     *
+     * @summary Invoiced quantity
+     *
+     * @name cbc:InvoicedQuantity (+ @unitCode)
+     */
+    invoicedQuantity: quantitySchema.pipe(
+      Schema.fieldsAssign({
+        /**
+         * @description The unit of measure that applies to the invoiced quantity. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in
+         * accordance with the descriptions in the "Intro" section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code
+         * values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code
+         * value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure.
+         *
+         * @example
+         *   `C62`;
+         *
+         * @summary Invoiced quantity unit of measure
+         *
+         * @see {@link quantityUnitCodes}
+         */
+        unitCode: quantityUnitCodesSchema(),
+      })
+    ),
+  })
+);
+
+export type PeppolInvoiceLine = typeof invoiceLineSchema.Type;

package/src/effect/fields/invoice-period-schema.ts

@@ -0,0 +1,31 @@
+import { Schema } from 'effect';
+
+import { vatDateCodeSchema } from '#/effect/values/vat-date-code';
+
+import { invoiceLinePeriodSchema } from './invoice-line-period-schema';
+
+/**
+ * @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`
+ */
+export const invoicePeriodSchema = invoiceLinePeriodSchema.pipe(
+  Schema.fieldsAssign({
+    /**
+     * @description The code of the date when the VAT becomes acccountable for the Seller and the Buyer.
+     *
+     * @example
+     *   `35`;
+     *
+     * @summary Value added tax point date code
+     *
+     * @name `cbc:DescriptionCode`
+     */
+    descriptionCode: Schema.optional(vatDateCodeSchema()),
+  })
+);
+
+export type PeppolInvoicePeriod = typeof invoicePeriodSchema.Type;

package/src/effect/fields/legal-monetary-total-schema.ts

@@ -0,0 +1,126 @@
+import { Schema } from 'effect';
+
+import { amountSchema } from './amount-schema';
+
+/**
+ * @description A group of business terms providing the monetary totals for the Invoice.
+ *
+ * @summary Document totals
+ *
+ * @name cac:LegalMonetaryTotal
+ */
+export const legalMonetaryTotalSchema = Schema.Struct({
+  /**
+   * @description Sum of all allowances on document level in the Invoice.
+   *
+   * @remarks
+   *   Must be rounded to maxium 2 decimals.
+   *
+   * @example
+   *   200.0;
+   *
+   * @summary Sum of allowances on document level
+   *
+   * @name `cbc:AllowanceTotalAmount (+ @currencyID)`
+   */
+  allowanceTotalAmount: Schema.optional(amountSchema),
+  /**
+   * @description Sum of all charges on document level in the Invoice.
+   *
+   * @remarks
+   *   Must be rounded to maximum 2 decimals.
+   *
+   * @example
+   *   0.0;
+   *
+   * @summary Sum of charges on document level
+   *
+   * @name `cbc:ChargeTotalAmount (+ @currencyID)`
+   */
+  chargeTotalAmount: Schema.optional(amountSchema),
+  /**
+   * @description Sum of all Invoice line net amounts in the Invoice.
+   *
+   * @remarks
+   *   Must be rounded to maximum 2 decimals.
+   *
+   * @example
+   *   3800.0;
+   *
+   * @summary Sum of Invoice line amount
+   *
+   * @name `cbc:LineExtensionAmount (+ @currencyID)`
+   */
+  lineExtensionAmount: amountSchema,
+  /**
+   * @description The amount due for payment on the Invoice, after accounting for all allowances, charges, prepayments, and rounding adjustments.
+   *
+   * @remarks
+   *   Must be rounded to maximum 2 decimals.
+   *
+   * @example
+   *   4500.0;
+   *
+   * @summary Amount due for payment
+   *
+   * @name `cbc:PayableAmount (+ @currencyID)`
+   */
+  payableAmount: amountSchema,
+  /**
+   * @description The rounding amount applied to the Invoice total.
+   *
+   * @remarks
+   *   Must be rounded to maximum 2 decimals.
+   *
+   * @example
+   *   0.0;
+   *
+   * @summary Rounding amount
+   *
+   * @name `cbc:PayableRoundingAmount (+ @currencyID)`
+   */
+  payableRoundingAmount: Schema.optional(amountSchema),
+  /**
+   * @description The sum of amounts which have been paid in advances.
+   *
+   * @remarks
+   *   Must be rounded to maximum 2 decimals.
+   *
+   * @example
+   *   0.0;
+   *
+   * @summary Paid amount
+   *
+   * @name `cbc:PrepaidAmount (+ @currencyID)`
+   */
+  prepaidAmount: Schema.optional(amountSchema),
+  /**
+   * @description The total amount of the Invoice without VAT.
+   *
+   * @remarks
+   *   Must be rounded to maximum 2 decimals.
+   *
+   * @example
+   *   3600.0;
+   *
+   * @summary Invoice total amount without VAT
+   *
+   * @name `cbc:TaxExclusiveAmount (+ @currencyID)`
+   */
+  taxExclusiveAmount: amountSchema,
+  /**
+   * @description The total amount of the Invoice with VAT.
+   *
+   * @example
+   *   4500.0;
+   *
+   * @summary Invoice total amount with VAT
+   *
+   * @remark Must be rounded to maximum 2 decimals.
+   *
+   * @name `cbc:TaxInclusiveAmount (+ @currencyID)`
+   */
+  taxInclusiveAmount: amountSchema,
+});
+
+export type PeppolLegalMonetaryTotal = typeof legalMonetaryTotalSchema.Type;

package/src/effect/fields/line-allowance-charge-schema.ts

@@ -0,0 +1,66 @@
+import { Schema } from 'effect';
+
+import { allowanceChargeReasonCodeSchema } from '#/effect/values/allowance-charge-reason-code';
+import { chargeReasonCodeSchema } from '#/effect/values/charge-reason-code';
+
+import { priceAllowanceChargeSchema } from './line-price-allowance-charge-schema';
+
+const baseLineAllowanceChargeSchema = priceAllowanceChargeSchema.pipe(
+  Schema.fieldsAssign({
+    /**
+     * @example
+     *   Discount;
+     *
+     * @name cbc:AllowanceChargeReason
+     */
+    allowanceChargeReason: Schema.optional(Schema.String),
+    /**
+     * @example
+     *   20;
+     *
+     * @name cbc:MultiplierFactorNumeric
+     */
+    multiplierFactorNumeric: Schema.optional(Schema.Number),
+  })
+);
+
+export const lineAllowanceChargeSchema = Schema.Union([
+  baseLineAllowanceChargeSchema.pipe(
+    Schema.fieldsAssign({
+      /**
+       * @name cbc:AllowanceChargeReasonCode
+       */
+      allowanceChargeReasonCode: Schema.optional(
+        allowanceChargeReasonCodeSchema('PEPPOL-EN16931-CL002: Reason code MUST be according to subset of UNCL 5189 D.16B.')
+      ),
+      /**
+       * @name cbc:ChargeIndicator
+       *
+       * @value false
+       */
+      chargeIndicator: Schema.Literal(false).annotate({
+        message: "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'",
+      }),
+    })
+  ),
+  baseLineAllowanceChargeSchema.pipe(
+    Schema.fieldsAssign({
+      /**
+       * @name cbc:AllowanceChargeReasonCode
+       */
+      allowanceChargeReasonCode: Schema.optional(chargeReasonCodeSchema('PEPPOL-EN16931-CL003: Reason code MUST be according to UNCL 7161 D.16B.')),
+      /**
+       * @name cbc:ChargeIndicator
+       *
+       * @value false
+       */
+      chargeIndicator: Schema.Literal(true).annotate({
+        message: "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'",
+      }),
+    })
+  ),
+]).annotate({ message: 'unable to decode line allowance charge' });
+
+export type PeppolLineAllowanceCharge = typeof lineAllowanceChargeSchema.Type;
+
+export { baseLineAllowanceChargeSchema };

package/src/effect/fields/line-item-schema.ts

@@ -0,0 +1,186 @@
+import { Schema } from 'effect';
+
+import { countryCodeSchema } from '#/effect/values/country-code';
+import { icdCodesSchema } from '#/effect/values/icd-codes';
+
+import { identifierSchema } from './identifier-schema';
+import { itemClassificationSchema } from './list-identifier-schema';
+import { taxCategorySchema } from './tax-category-schema';
+
+/**
+ * @summary Item details on invoice/credit-note line
+ *
+ * @name cac:Item
+ */
+export const lineItemSchema = Schema.Struct({
+  /**
+   * @description A description for an item. The item description allows for descibing the item and its features in more detail than the item name.
+   *
+   * @summary Item description
+   *
+   * @name cbc:Description
+   */
+  description: Schema.optional(Schema.String),
+  /**
+   * @description A name for an item.
+   *
+   * @summary Item name
+   *
+   * @name cbc:Name
+   */
+  name: Schema.String,
+  /**
+   * @summary BUYERS ITEM IDENTIFICATION
+   *
+   * @name cac:BuyersItemIdentification
+   */
+  buyersItemIdentification: Schema.optional(
+    Schema.Struct({
+      /**
+       * @description An identifier, assigned by the Buyer, for the item.
+       *
+       * @example
+       *   `12345`;
+       *
+       * @summary Item Buyer's identifier
+       *
+       * @name `cbc:ID`
+       */
+      id: Schema.String,
+    })
+  ),
+  /**
+   * @summary Sellers item identification
+   *
+   * @name cac:SellersItemIdentification
+   */
+  sellersItemIdentification: Schema.optional(
+    Schema.Struct({
+      /**
+       * @description An identifier, assigned by the Seller, for the item.
+       *
+       * @example
+       *   `987323`;
+       *
+       * @summary Item Seller's identifier
+       *
+       * @name `cbc:ID`
+       */
+      id: Schema.String,
+    })
+  ),
+  /**
+   * @summary Standard item identification
+   *
+   * @name cac:StandardItemIdentification
+   */
+  standardItemIdentification: Schema.optional(
+    Schema.Struct({
+      /**
+       * @description An item identifier based on a registered scheme.
+       *
+       * @summary Item standard identifier
+       *
+       * @name `cbc:ID`
+       */
+      id: identifierSchema().pipe(
+        Schema.fieldsAssign({
+          /**
+           * @description An item identifier based on a registered scheme.
+           *
+           * @summary Item standard identifier
+           *
+           * @name `#text`
+           */
+          id: Schema.String,
+          /**
+           * @description The identification scheme identifier of the Item standard identifier.
+           *
+           * @summary Item standard identifier identification scheme identifier
+           *
+           * @name `@schemeID`
+           */
+          schemeId: icdCodesSchema(),
+        })
+      ),
+    })
+  ),
+  /**
+   * @summary ORIGIN COUNTRY
+   *
+   * @name `cac:OriginCountry`
+   */
+  originCountryCode: Schema.optional(
+    Schema.Struct({
+      /**
+       * @description The code identifying the country from which the item originates.
+       *
+       * @summary Item country of origin
+       *
+       * @name `cbc:IdentificationCode`
+       */
+      identificationCode: countryCodeSchema,
+    })
+  ),
+  /**
+   * @summary COMMODITY CLASSIFICATION
+   *
+   * @name cac:CommodityClassification (0..n)
+   */
+  commodityClassifications: Schema.optional(
+    Schema.Array(
+      Schema.Struct({
+        /**
+         * @description A code for classifying the item by its type or nature.
+         *
+         * @example
+         *   `9873242`;
+         *
+         * @summary Item classification identifier
+         *
+         * @name `cbc:ItemClassificationCode`
+         */
+        itemClassification: itemClassificationSchema,
+      })
+    )
+  ),
+  /**
+   * @description A group of business terms providing information about the VAT applicable for the goods and services invoiced on the Invoice line.
+   *
+   * @summary LINE VAT INFORMATION
+   *
+   * @name cac:ClassifiedTaxCategory
+   */
+  classifiedTaxCategory: taxCategorySchema,
+  /**
+   * @description A group of business terms providing information about properties of the goods and services invoiced.
+   *
+   * @summary ITEM ATTRIBUTES
+   *
+   * @name cac:AdditionalItemProperty
+   */
+  additionalItemProperties: Schema.optional(
+    Schema.Array(
+      Schema.Struct({
+        /**
+         * @description The name of the attribute or property of the item.
+         *
+         * @summary Item attribute name
+         *
+         * @name cbc:Name
+         */
+        name: Schema.String,
+        /**
+         * @description The value of the attribute or property of the item.
+         *
+         * @summary Item attribute value
+         *
+         * @name cbc:Value
+         */
+        value: Schema.String,
+      })
+    )
+  ),
+});
+
+export type PeppolItem = typeof lineItemSchema.Type;

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

@@ -0,0 +1,38 @@
+import { Schema } from 'effect';
+
+import { amountSchema } from './amount-schema';
+
+const priceAllowanceChargeSchema = Schema.Struct({
+  /**
+   * @example
+   *   200;
+   *
+   * @name cbc:Amount (+ @currencyID)
+   */
+  amount: amountSchema,
+  /**
+   * @example
+   *   1000;
+   *
+   * @name cbc:BaseAmount (+ @currencyID)
+   */
+  baseAmount: Schema.optional(amountSchema),
+  /**
+   * @name cbc:ChargeIndicator
+   *
+   * @value false
+   */
+  chargeIndicator: Schema.Boolean,
+});
+
+export const linePriceAllowanceChargeSchema = priceAllowanceChargeSchema.pipe(
+  Schema.fieldsAssign({
+    chargeIndicator: Schema.Literal(false).annotate({
+      message: "PEPPOL-EN16931-R044: Charge on price level is NOT allowed. Only value 'false' allowed.",
+    }),
+  })
+);
+
+export type PeppolLinePriceAllowanceCharge = typeof linePriceAllowanceChargeSchema.Type;
+
+export { priceAllowanceChargeSchema };

package/src/effect/fields/list-identifier-schema.ts

@@ -0,0 +1,45 @@
+import { Schema } from 'effect';
+
+import { itemClassificationCodesSchema } from '#/effect/values/item-classification-code-schema';
+
+/**
+ * @description A code for classifying the item by its type or nature.
+ *
+ * @example
+ *   `9873242`;
+ *
+ * @summary Item classification identifier
+ *
+ * @name `cbc:ItemClassificationCode`
+ */
+export const itemClassificationSchema = Schema.Struct({
+  /**
+   * @description A code for classifying the item by its type or nature.
+   *
+   * @summary Item classification identifier
+   *
+   * @name `#text`
+   */
+  id: Schema.String,
+  /**
+   * @description The identification scheme identifier of the item classification identifier.
+   *
+   * @summary Item classification identifier identification scheme identifier
+   *
+   * @name `@listID`
+   */
+  listId: itemClassificationCodesSchema(),
+  /**
+   * @description The identification scheme version identifier of the Item classification identifier.
+   *
+   * @remarks
+   *   Only used with danish.
+   *
+   * @summary Item classification identifier version identification scheme identifier
+   *
+   * @name `@listVersionID`
+   */
+  listVersionId: Schema.optional(Schema.String),
+});
+
+export type PeppolItemClassification = typeof itemClassificationSchema.Type;