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

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

@@ -1,42 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolBaseLineSchema } from '#/effect/fields/peppol-base-line-schema';
-import { peppolQuantitySchema } from '#/effect/fields/peppol-quantity-schema';
-import { quantityUnitCodesSchema } from '#/effect/values/quantity-unit-codes-schema';
-
-/**
- * @description Credit note line is identical to Invoice line except the quantity element name.
- */
-export const peppolCreditNoteLineSchema = peppolBaseLineSchema.pipe(
-  Schema.fieldsAssign({
-    /**
-     * @description Invoiced/Credited quantity.
-     *
-     * @example
-     *   { value: 40, unitCode: "C62" }
-     *
-     * @name cbc:CreditedQuantity (+ @unitCode)
-     */
-    creditedQuantity: peppolQuantitySchema.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 interface PeppolCreditNoteLine extends Schema.Schema.Type<typeof peppolCreditNoteLineSchema> {}
-export interface PeppolCreditNoteLineEncoded extends Schema.Codec.Encoded<typeof peppolCreditNoteLineSchema> {}

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

@@ -1,100 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolIsoDateStringSchema } from '#/effect/peppol-iso-date-string-schema';
-import { icdCodesSchema } from '#/effect/values/icd-codes-schema';
-
-import { peppolAddressSchema } from './peppol-address-schema';
-import { peppolIdentifierSchema } from './peppol-identifier-schema';
-
-export const peppolDeliverySchema = 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(peppolIsoDateStringSchema),
-  /**
-   * @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(
-        peppolIdentifierSchema.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(peppolAddressSchema),
-    })
-  ),
-
-  /**
-   * @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 peppolDeliverySchema.Type;

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

@@ -1,19 +0,0 @@
-import { Schema } from 'effect';
-
-/**
- * @summary Identifier with optional scheme
- *
- * @name `cbc:ID (+ optional @schemeID)`
- */
-export const peppolIdentifierSchema = Schema.Struct({
-  /**
-   * @name cbc:ID
-   */
-  id: Schema.String,
-  /**
-   * @name `@schemeID`
-   */
-  schemeId: Schema.optional(Schema.String),
-});
-
-export type PeppolIdentifier = typeof peppolIdentifierSchema.Type;

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

@@ -1,34 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolIsoDateStringSchema } from '#/effect/peppol-iso-date-string-schema';
-
-export const peppolInvoiceLinePeriodSchema = 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(peppolIsoDateStringSchema),
-  /**
-   * @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(peppolIsoDateStringSchema),
-});
-
-export type PeppolInvoiceLinePeriod = typeof peppolInvoiceLinePeriodSchema.Type;

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

@@ -1,30 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolInvoiceLinePeriodSchema } from '#/effect/fields/peppol-invoice-line-period-schema';
-import { vatDateCodeSchema } from '#/effect/values/vat-date-code-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 peppolInvoicePeriodSchema = peppolInvoiceLinePeriodSchema.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 peppolInvoicePeriodSchema.Type;

package/src/effect/fields/peppol-item-classification-schema.ts

@@ -1,45 +0,0 @@
-import { Schema } from 'effect';
-
-import { itemClassificationCodesSchema } from '#/effect/values/item-classification-codes-schema';
-
-/**
- * @description A code for classifying the item by its type or nature.
- *
- * @example
- *   `9873242`;
- *
- * @summary Item classification identifier
- *
- * @name `cbc:ItemClassificationCode`
- */
-export const peppolItemClassificationSchema = 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 peppolItemClassificationSchema.Type;

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

@@ -1,126 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolAmountSchema } from '#/effect/fields/peppol-amount-schema';
-
-/**
- * @description A group of business terms providing the monetary totals for the Invoice.
- *
- * @summary Document totals
- *
- * @name cac:LegalMonetaryTotal
- */
-export const peppolLegalMonetaryTotalSchema = 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(peppolAmountSchema),
-  /**
-   * @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(peppolAmountSchema),
-  /**
-   * @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: peppolAmountSchema,
-  /**
-   * @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: peppolAmountSchema,
-  /**
-   * @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(peppolAmountSchema),
-  /**
-   * @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(peppolAmountSchema),
-  /**
-   * @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: peppolAmountSchema,
-  /**
-   * @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: peppolAmountSchema,
-});
-
-export type PeppolLegalMonetaryTotal = typeof peppolLegalMonetaryTotalSchema.Type;

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

@@ -1,64 +0,0 @@
-import { Schema } from 'effect';
-
-import { priceAllowanceChargeSchema } from '#/effect/fields/peppol-line-price-allowance-charge-schema';
-import { allowanceChargeReasonCodeSchema } from '#/effect/values/allowance-charge-reason-code-schema';
-import { chargeReasonCodeSchema } from '#/effect/values/charge-reason-code-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.Finite),
-  })
-);
-
-export const peppolLineAllowanceChargeSchema = Schema.Union([
-  baseLineAllowanceChargeSchema.pipe(
-    Schema.fieldsAssign({
-      /**
-       * @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'",
-      }),
-    })
-  ),
-  baseLineAllowanceChargeSchema.pipe(
-    Schema.fieldsAssign({
-      /**
-       * @name cbc:AllowanceChargeReasonCode
-       */
-      allowanceChargeReasonCode: Schema.optional(chargeReasonCodeSchema),
-      /**
-       * @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 peppolLineAllowanceChargeSchema.Type;
-export type PeppolLineAllowanceChargeEncoded = typeof peppolLineAllowanceChargeSchema.Encoded;
-
-export { baseLineAllowanceChargeSchema };

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

@@ -1,185 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolIdentifierSchema } from '#/effect/fields/peppol-identifier-schema';
-import { peppolItemClassificationSchema } from '#/effect/fields/peppol-item-classification-schema';
-import { peppolTaxCategorySchema } from '#/effect/fields/peppol-tax-category-schema';
-import { icdCodesSchema } from '#/effect/values/icd-codes-schema';
-import { peppolCountryCodeSchema } from '#/effect/values/peppol-country-code-schema';
-
-/**
- * @summary Item details on invoice/credit-note line
- *
- * @name cac:Item
- */
-export const peppolLineItemSchema = 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: peppolIdentifierSchema.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: peppolCountryCodeSchema,
-    })
-  ),
-  /**
-   * @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: peppolItemClassificationSchema,
-      })
-    )
-  ),
-  /**
-   * @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: peppolTaxCategorySchema,
-  /**
-   * @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 peppolLineItemSchema.Type;

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

@@ -1,38 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolAmountSchema } from '#/effect/fields/peppol-amount-schema';
-
-const priceAllowanceChargeSchema = Schema.Struct({
-  /**
-   * @example
-   *   200;
-   *
-   * @name cbc:Amount (+ @currencyID)
-   */
-  amount: peppolAmountSchema,
-  /**
-   * @example
-   *   1000;
-   *
-   * @name cbc:BaseAmount (+ @currencyID)
-   */
-  baseAmount: Schema.optional(peppolAmountSchema),
-  /**
-   * @name cbc:ChargeIndicator
-   *
-   * @value false
-   */
-  chargeIndicator: Schema.Boolean,
-});
-
-export const peppolLinePriceAllowanceChargeSchema = 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 peppolLinePriceAllowanceChargeSchema.Type;
-
-export { priceAllowanceChargeSchema };