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

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

@@ -1,95 +0,0 @@
-import * as z from 'zod/mini';
-
-import { addressSchema } from '#/schemas/fields/address-schema';
-import { identifierSchema } from '#/schemas/fields/identifier-schema';
-import { icdCodesSchema } from '#/schemas/values/icd-codes';
-
-export const deliverySchema = z.object({
-  /**
-   * @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: z.optional(z.iso.date()),
-  /**
-   * @name `cac:DeliveryLocation`
-   */
-  deliveryLocation: z.optional(
-    z.object({
-      /**
-       * @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: z.optional(
-        z.safeExtend(identifierSchema(), {
-          /**
-           * @description An identifier for the location at which the goods and services are delivered.
-           *
-           * @example
-           *   `83745498753497`;
-           *
-           * @summary Deliver to location identifier
-           *
-           * @name `#text`
-           */
-          id: z.string(),
-          /**
-           * @description The identification scheme identifier of the Deliver to location identifier.
-           *
-           * @summary Deliver to location identifier identification scheme identifier
-           *
-           * @name `@schemeID`
-           */
-          schemeId: z.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: z.optional(addressSchema),
-    })
-  ),
-
-  /**
-   * @summary Delivery party
-   *
-   * @name `cac:DeliveryParty`
-   */
-  deliveryParty: z.optional(
-    z.object({
-      /**
-       * @summary PARTY NAME
-       *
-       * @name `cac:PartyName`
-       */
-      partyName: z.object({
-        /**
-         * @description The name of the party to which the goods and services are delivered.
-         *
-         * @summary Deliver to party name
-         *
-         * @name `cbc:Name`
-         */
-        name: z.string(),
-      }),
-    })
-  ),
-});
-export type PeppolDelivery = z.infer<typeof deliverySchema>;

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

@@ -1,24 +0,0 @@
-import * as z from 'zod/mini';
-
-/**
- * @summary Identifier with optional scheme
- *
- * @name `cbc:ID (+ optional @schemeID)`
- */
-export function identifierSchema(message?: string | z.core.$ZodObjectParams) {
-  return z.object(
-    {
-      /**
-       * @name cbc:ID
-       */
-      id: z.string(),
-      /**
-       * @name `@schemeID`
-       */
-      schemeId: z.optional(z.string()),
-    },
-    message
-  );
-}
-
-export type PeppolIdentifier = z.infer<ReturnType<typeof identifierSchema>>;

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

@@ -1,31 +0,0 @@
-import * as z from 'zod/mini';
-
-export const invoiceLinePeriodSchema = z.object({
-  /**
-   * @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: z.optional(z.iso.date()),
-  /**
-   * @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: z.optional(z.iso.date()),
-});
-export type PeppolInvoiceLinePeriod = z.infer<typeof invoiceLinePeriodSchema>;

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

@@ -1,41 +0,0 @@
-import * as z from 'zod/mini';
-
-import { baseLineSchema } from '#/schemas/fields/base-line-schema';
-import { quantitySchema } from '#/schemas/fields/quantity-schema';
-import { quantityUnitCodesSchema } from '#/schemas/values/quantity-unit-codes-schema';
-
-/**
- * @summary Invoice line
- *
- * @name cac:InvoiceLine
- */
-export const invoiceLineSchema = z.extend(baseLineSchema, {
-  /**
-   * @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: z.safeExtend(quantitySchema, {
-    /**
-     * @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 = z.infer<typeof invoiceLineSchema>;

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

@@ -1,27 +0,0 @@
-import * as z from 'zod/mini';
-
-import { invoiceLinePeriodSchema } from '#/schemas/fields/invoice-line-period-schema';
-import { vatDateCodeSchema } from '#/schemas/values/vat-date-code';
-
-/**
- * @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 = z.extend(invoiceLinePeriodSchema, {
-  /**
-   * @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: z.optional(vatDateCodeSchema()),
-});
-export type PeppolInvoicePeriod = z.infer<typeof invoicePeriodSchema>;

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

@@ -1,125 +0,0 @@
-import * as z from 'zod/mini';
-
-import { amountSchema } from '#/schemas/fields/amount-schema';
-
-/**
- * @description A group of business terms providing the monetary totals for the Invoice.
- *
- * @summary Document totals
- *
- * @name cac:LegalMonetaryTotal
- */
-export const legalMonetaryTotalSchema = z.object({
-  /**
-   * @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: z.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: z.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: z.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: z.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 = z.infer<typeof legalMonetaryTotalSchema>;

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

@@ -1,59 +0,0 @@
-import * as z from 'zod/mini';
-
-import { priceAllowanceChargeSchema } from '#/schemas/fields/line-price-allowance-charge-schema';
-import { allowanceChargeReasonCodeSchema } from '#/schemas/values/allowance-charge-reason-code';
-import { chargeReasonCodeSchema } from '#/schemas/values/charge-reason-code';
-
-const baseLineAllowanceChargeSchema = z.extend(priceAllowanceChargeSchema, {
-  /**
-   * @example
-   *   Discount;
-   *
-   * @name cbc:AllowanceChargeReason
-   */
-  allowanceChargeReason: z.optional(z.string()),
-  /**
-   * @example
-   *   20;
-   *
-   * @name cbc:MultiplierFactorNumeric
-   */
-  multiplierFactorNumeric: z.optional(z.number()),
-});
-
-export const lineAllowanceChargeSchema = z.discriminatedUnion(
-  'chargeIndicator',
-  [
-    z.extend(baseLineAllowanceChargeSchema, {
-      /**
-       * @name cbc:AllowanceChargeReasonCode
-       */
-      allowanceChargeReasonCode: z.optional(
-        allowanceChargeReasonCodeSchema('PEPPOL-EN16931-CL002: Reason code MUST be according to subset of UNCL 5189 D.16B.')
-      ),
-      /**
-       * @name cbc:ChargeIndicator
-       *
-       * @value false
-       */
-      chargeIndicator: z.literal(false, "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'"),
-    }),
-    z.extend(baseLineAllowanceChargeSchema, {
-      /**
-       * @name cbc:AllowanceChargeReasonCode
-       */
-      allowanceChargeReasonCode: z.optional(chargeReasonCodeSchema('PEPPOL-EN16931-CL003: Reason code MUST be according to UNCL 7161 D.16B.')),
-      /**
-       * @name cbc:ChargeIndicator
-       *
-       * @value false
-       */
-      chargeIndicator: z.literal(true, "PEPPOL-EN16931-R043: Allowance/charge ChargeIndicator value MUST equal 'true' or 'false'"),
-    }),
-  ],
-  'unable to decode line allowance charge'
-);
-
-export type PeppolLineAllowanceCharge = z.infer<typeof lineAllowanceChargeSchema>;
-
-export { baseLineAllowanceChargeSchema };

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

@@ -1,183 +0,0 @@
-import * as z from 'zod/mini';
-
-import { identifierSchema } from '#/schemas/fields/identifier-schema';
-import { itemClassificationSchema } from '#/schemas/fields/list-identifier-schema';
-import { taxCategorySchema } from '#/schemas/fields/tax-category-schema';
-import { countryCodeSchema } from '#/schemas/values/country-code';
-import { icdCodesSchema } from '#/schemas/values/icd-codes';
-
-/**
- * @summary Item details on invoice/credit-note line
- *
- * @name cac:Item
- */
-export const lineItemSchema = z.object({
-  /**
-   * @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: z.optional(z.string()),
-  /**
-   * @description A name for an item.
-   *
-   * @summary Item name
-   *
-   * @name cbc:Name
-   */
-  name: z.string(),
-  /**
-   * @summary BUYERS ITEM IDENTIFICATION
-   *
-   * @name cac:BuyersItemIdentification
-   */
-  buyersItemIdentification: z.optional(
-    z.object({
-      /**
-       * @description An identifier, assigned by the Buyer, for the item.
-       *
-       * @example
-       *   `12345`;
-       *
-       * @summary Item Buyer's identifier
-       *
-       * @name `cbc:ID`
-       */
-      id: z.string(),
-    })
-  ),
-  /**
-   * @summary Sellers item identification
-   *
-   * @name cac:SellersItemIdentification
-   */
-  sellersItemIdentification: z.optional(
-    z.object({
-      /**
-       * @description An identifier, assigned by the Seller, for the item.
-       *
-       * @example
-       *   `987323`;
-       *
-       * @summary Item Seller's identifier
-       *
-       * @name `cbc:ID`
-       */
-      id: z.string(),
-    })
-  ),
-  /**
-   * @summary Standard item identification
-   *
-   * @name cac:StandardItemIdentification
-   */
-  standardItemIdentification: z.optional(
-    z.object({
-      /**
-       * @description An item identifier based on a registered scheme.
-       *
-       * @summary Item standard identifier
-       *
-       * @name `cbc:ID`
-       */
-      id: z.safeExtend(identifierSchema(), {
-        /**
-         * @description An item identifier based on a registered scheme.
-         *
-         * @summary Item standard identifier
-         *
-         * @name `#text`
-         */
-        id: z.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: z.optional(
-    z.object({
-      /**
-       * @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: z.optional(
-    z.array(
-      z.object({
-        /**
-         * @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: z.optional(
-    z.array(
-      z.object({
-        /**
-         * @description The name of the attribute or property of the item.
-         *
-         * @summary Item attribute name
-         *
-         * @name cbc:Name
-         */
-        name: z.string(),
-        /**
-         * @description The value of the attribute or property of the item.
-         *
-         * @summary Item attribute value
-         *
-         * @name cbc:Value
-         */
-        value: z.string(),
-      })
-    )
-  ),
-});
-
-export type PeppolItem = z.infer<typeof lineItemSchema>;

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

@@ -1,33 +0,0 @@
-import * as z from 'zod/mini';
-
-import { amountSchema } from '#/schemas/fields/amount-schema';
-
-const priceAllowanceChargeSchema = z.object({
-  /**
-   * @example
-   *   200;
-   *
-   * @name cbc:Amount (+ @currencyID)
-   */
-  amount: amountSchema,
-  /**
-   * @example
-   *   1000;
-   *
-   * @name cbc:BaseAmount (+ @currencyID)
-   */
-  baseAmount: z.optional(amountSchema),
-  /**
-   * @name cbc:ChargeIndicator
-   *
-   * @value false
-   */
-  chargeIndicator: z.boolean(),
-});
-
-export const linePriceAllowanceChargeSchema = z.safeExtend(priceAllowanceChargeSchema, {
-  chargeIndicator: z.literal(false, "PEPPOL-EN16931-R044: Charge on price level is NOT allowed. Only value 'false' allowed."),
-});
-export type PeppolLinePriceAllowanceCharge = z.infer<typeof linePriceAllowanceChargeSchema>;
-
-export { priceAllowanceChargeSchema };

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

@@ -1,43 +0,0 @@
-import * as z from 'zod/mini';
-
-import { itemClassificationCodesSchema } from '#/schemas/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 = z.object({
-  /**
-   * @description A code for classifying the item by its type or nature.
-   *
-   * @summary Item classification identifier
-   *
-   * @name `#text`
-   */
-  id: z.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: z.optional(z.string()),
-});

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

@@ -1,36 +0,0 @@
-import * as z from 'zod/mini';
-
-/**
- * @summary ORDER AND SALES ORDER REFERENCE
- *
- * @name cac:OrderReference
- */
-export const orderReferenceSchema = z.object({
-  /**
-   * @description An identifier of a referenced purchase order, issued by the Buyer. An identifier of a referenced purchase order, issued by the Buyer. An invoice
-   * must have buyer reference (BT-10) or purchase order reference. In cases where sales order reference is provided, but there's no purchase order
-   * reference, then use value "NA" as this element is mandatory in UBL.
-   *
-   * @example
-   *   `98776`;
-   *
-   * @summary Purchase order reference
-   *
-   * @name `cbc:ID`
-   */
-  id: z.string(),
-  /**
-   * @description An identifier of a referenced Sales order, issued by the Seller. In cases where sales order reference is provided, but there's no purchase order
-   * reference, then set cac:OrderReference/cbc:ID to value "NA" as this element is mandatory in UBL.
-   *
-   * @example
-   *   `112233`;
-   *
-   * @summary Sales order reference
-   *
-   * @name `cbc:SalesOrderID`
-   */
-  salesOrderId: z.optional(z.string()),
-});
-
-export type PeppolOrderReference = z.infer<typeof orderReferenceSchema>;