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

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

@@ -0,0 +1,127 @@
+import { Schema } from 'effect';
+
+import { PeppolAmount } from '#/schemas/fields/peppol-amount-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+/**
+ * @description A group of business terms providing the monetary totals for the Invoice.
+ *
+ * @summary Document totals
+ *
+ * @name cac:LegalMonetaryTotal
+ */
+export class PeppolLegalMonetaryTotal extends opaque<PeppolLegalMonetaryTotal>()(
+  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(PeppolAmount),
+    /**
+     * @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(PeppolAmount),
+    /**
+     * @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: PeppolAmount,
+    /**
+     * @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: PeppolAmount,
+    /**
+     * @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(PeppolAmount),
+    /**
+     * @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(PeppolAmount),
+    /**
+     * @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: PeppolAmount,
+    /**
+     * @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: PeppolAmount,
+  })
+) {}

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

@@ -0,0 +1,68 @@
+import { Schema } from 'effect';
+
+import { PriceAllowanceCharge } from '#/schemas/fields/peppol-line-price-allowance-charge-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';
+
+export class BaseLineAllowanceCharge extends opaque<BaseLineAllowanceCharge>()(
+  Schema.Struct({
+    ...PriceAllowanceCharge.fields /**
+     * @example
+     *   Discount;
+     *
+     * @name cbc:AllowanceChargeReason
+     */,
+    allowanceChargeReason: Schema.optional(Schema.String),
+    /**
+     * @example
+     *   20;
+     *
+     * @name cbc:MultiplierFactorNumeric
+     */
+    multiplierFactorNumeric: Schema.optional(Schema.Finite),
+  })
+) {}
+
+export class PeppolLineAllowance extends opaque<PeppolLineAllowance>()(
+  Schema.Struct({
+    ...BaseLineAllowanceCharge.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 PeppolLineCharge extends opaque<PeppolLineCharge>()(
+  Schema.Struct({
+    ...BaseLineAllowanceCharge.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'",
+    }),
+  })
+) {}
+
+export const peppolLineAllowanceChargeSchema = Schema.Union([PeppolLineAllowance, PeppolLineCharge]).annotate({
+  message: 'unable to decode line allowance charge',
+});
+
+export type PeppolLineAllowanceCharge = typeof peppolLineAllowanceChargeSchema.Type;
+export type PeppolLineAllowanceChargeEncoded = typeof peppolLineAllowanceChargeSchema.Encoded;

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

@@ -0,0 +1,196 @@
+import { Schema } from 'effect';
+
+import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema';
+import { PeppolItemClassification } from '#/schemas/fields/peppol-item-classification-schema';
+import { PeppolTaxCategory } from '#/schemas/fields/peppol-tax-category-schema';
+import { opaque } from '#/schemas/utils/opaque';
+import { icdCodesSchema } from '#/schemas/values/icd-codes-schema';
+import { peppolCountryCodeSchema } from '#/schemas/values/peppol-country-code-schema';
+
+class PeppolAdditionalItemProperties extends opaque<PeppolAdditionalItemProperties>()(
+  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,
+  })
+) {}
+
+class PeppolCommodityClassifications extends opaque<PeppolCommodityClassifications>()(
+  Schema.Struct({
+    /**
+     * @description A code for classifying the item by its type or nature.
+     *
+     * @example
+     *   `9873242`;
+     *
+     * @summary Item classification identifier
+     *
+     * @name `cbc:ItemClassificationCode`
+     */
+    itemClassification: PeppolItemClassification,
+  })
+) {}
+
+class PeppolOriginCountryCode extends opaque<PeppolOriginCountryCode>()(
+  Schema.Struct({
+    /**
+     * @description The code identifying the country from which the item originates.
+     *
+     * @summary Item country of origin
+     *
+     * @name `cbc:IdentificationCode`
+     */
+    identificationCode: peppolCountryCodeSchema,
+  })
+) {}
+
+class PeppolStandardItemIdentification extends opaque<PeppolStandardItemIdentification>()(
+  Schema.Struct({
+    /**
+     * @description An item identifier based on a registered scheme.
+     *
+     * @summary Item standard identifier
+     *
+     * @name `cbc:ID`
+     */
+    id: PeppolIdentifier.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,
+      })
+    ),
+  })
+) {}
+
+class PeppolSellersItemIdentification extends opaque<PeppolSellersItemIdentification>()(
+  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,
+  })
+) {}
+
+class PeppolBuyersItemIdentification extends opaque<PeppolBuyersItemIdentification>()(
+  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 Item details on invoice/credit-note line
+ *
+ * @name cac:Item
+ */
+export class PeppolLineItem extends opaque<PeppolLineItem>()(
+  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(PeppolBuyersItemIdentification),
+    /**
+     * @summary Sellers item identification
+     *
+     * @name cac:SellersItemIdentification
+     */
+    sellersItemIdentification: Schema.optional(PeppolSellersItemIdentification),
+    /**
+     * @summary Standard item identification
+     *
+     * @name cac:StandardItemIdentification
+     */
+    standardItemIdentification: Schema.optional(PeppolStandardItemIdentification),
+    /**
+     * @summary ORIGIN COUNTRY
+     *
+     * @name `cac:OriginCountry`
+     */
+    originCountryCode: Schema.optional(PeppolOriginCountryCode),
+    /**
+     * @summary COMMODITY CLASSIFICATION
+     *
+     * @name cac:CommodityClassification (0..n)
+     */
+    commodityClassifications: Schema.optional(Schema.Array(PeppolCommodityClassifications)),
+    /**
+     * @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: PeppolTaxCategory,
+    /**
+     * @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(PeppolAdditionalItemProperties)),
+  })
+) {}
+
+export type PeppolItem = PeppolLineItem;

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

@@ -0,0 +1,41 @@
+import { Schema } from 'effect';
+
+import { PeppolAmount } from '#/schemas/fields/peppol-amount-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+class PriceAllowanceCharge extends opaque<PriceAllowanceCharge>()(
+  Schema.Struct({
+    /**
+     * @example
+     *   200;
+     *
+     * @name cbc:Amount (+ @currencyID)
+     */
+    amount: PeppolAmount,
+    /**
+     * @example
+     *   1000;
+     *
+     * @name cbc:BaseAmount (+ @currencyID)
+     */
+    baseAmount: Schema.optional(PeppolAmount),
+    /**
+     * @name cbc:ChargeIndicator
+     *
+     * @value false
+     */
+    chargeIndicator: Schema.Boolean,
+  })
+) {}
+
+export class PeppolLinePriceAllowanceCharge extends opaque<PeppolLinePriceAllowanceCharge>()(
+  PriceAllowanceCharge.pipe(
+    Schema.fieldsAssign({
+      chargeIndicator: Schema.Literal(false).annotate({
+        message: "PEPPOL-EN16931-R044: Charge on price level is NOT allowed. Only value 'false' allowed.",
+      }),
+    })
+  )
+) {}
+
+export { PriceAllowanceCharge };

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

@@ -0,0 +1,32 @@
+import { Schema } from 'effect';
+
+import { PeppolAmount } from '#/schemas/fields/peppol-amount-schema';
+import { PeppolLinePriceAllowanceCharge } from '#/schemas/fields/peppol-line-price-allowance-charge-schema';
+import { PeppolQuantity } from '#/schemas/fields/peppol-quantity-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+/**
+ * @summary Price details on invoice line
+ *
+ * @name cac:Price
+ */
+export class PeppolLinePrice extends opaque<PeppolLinePrice>()(
+  Schema.Struct({
+    /**
+     * @name cac:AllowanceCharge
+     *
+     * @cardinality 0..1
+     */
+    allowanceCharge: Schema.optional(PeppolLinePriceAllowanceCharge),
+    /**
+     * @name cbc:BaseQuantity (+ @unitCode)
+     *
+     * @cardinality 0..1
+     */
+    baseQuantity: Schema.optional(PeppolQuantity),
+    /**
+     * @name cbc:PriceAmount (+ @currencyID)
+     */
+    priceAmount: PeppolAmount,
+  })
+) {}

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

@@ -0,0 +1,38 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+
+/**
+ * @summary ORDER AND SALES ORDER REFERENCE
+ *
+ * @name cac:OrderReference
+ */
+export class PeppolOrderReference extends opaque<PeppolOrderReference>()(
+  Schema.Struct({
+    /**
+     * @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: Schema.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: Schema.optional(Schema.String),
+  })
+) {}

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

@@ -0,0 +1,145 @@
+import { Schema } from 'effect';
+
+import { PeppolAddress } from '#/schemas/fields/peppol-address-schema';
+import { PeppolContact } from '#/schemas/fields/peppol-contact-schema';
+import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema';
+import { PeppolPartyLegalEntity } from '#/schemas/fields/peppol-party-legal-entity-schema';
+import { PeppolPartyTaxScheme } from '#/schemas/fields/peppol-party-tax-scheme-schema';
+import { opaque } from '#/schemas/utils/opaque';
+import { electronicCodesSchema } from '#/schemas/values/electronic-codes-schema';
+import { icdCodesSchema } from '#/schemas/values/icd-codes-schema';
+
+export class PeppolPartyName extends opaque<PeppolPartyName>()(
+  Schema.Struct({
+    /**
+     * @description A name by which the Buyer/Seller is known, other than Buyer/Seller name (also known as Business name).
+     *
+     * @example
+     *   `Trading Name`;
+     *
+     * @summary Buyer/Seller trading name
+     */
+    name: Schema.String,
+  })
+) {}
+
+export class PeppolPartyIdentification extends opaque<PeppolPartyIdentification>()(
+  Schema.Struct({
+    /**
+     * @description An identifier of the Buyer/seller.
+     *
+     * @summary Buyer/seller identifier
+     *
+     * @name `cbc:ID`
+     */
+    id: PeppolIdentifier.pipe(
+      Schema.fieldsAssign({
+        /**
+         * @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.
+         *
+         * @example
+         *   7300010000001;
+         *
+         * @summary Seller/Buyer electronic address
+         *
+         * @name `#text`
+         */
+        id: Schema.String,
+        /**
+         * @description The identification scheme identifier of the Seller/Buyer electronic address.
+         *
+         * @summary Seller/Buyer electronic address identification scheme identifier
+         *
+         * @name `@schemeID`
+         */
+        schemeId: Schema.optional(icdCodesSchema),
+      })
+    ),
+  })
+) {}
+
+export class PeppolPartyEndpointId extends opaque<PeppolPartyEndpointId>()(
+  PeppolIdentifier.pipe(
+    Schema.fieldsAssign({
+      /**
+       * @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.
+       *
+       * @example
+       *   7300010000001;
+       *
+       * @summary Seller/Buyer electronic address
+       *
+       * @name `#text`
+       */
+      id: Schema.String,
+      /**
+       * @description The identification scheme identifier of the Seller/Buyer electronic address.
+       *
+       * @summary Seller/Buyer electronic address identification scheme identifier
+       *
+       * @name `@schemeID`
+       */
+      schemeId: electronicCodesSchema,
+    })
+  )
+) {}
+
+/**
+ * @summary Party common substructure
+ *
+ * @name cac:Party
+ */
+export class PeppolPartySchema extends opaque<PeppolPartySchema>()(
+  Schema.Struct({
+    /**
+     * @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.
+     *
+     * @example
+     *   7300010000001;
+     *
+     * @summary Seller/Buyer electronic address
+     *
+     * @name `cbc:EndpointID`
+     */
+    endpointId: PeppolPartyEndpointId,
+    /**
+     * @example
+     *   5060012349998;
+     *
+     * @summary PARTY IDENTIFICATION
+     *
+     * @name `cac:PartyIdentification`
+     */
+    partyIdentification: Schema.optional(PeppolPartyIdentification),
+    /**
+     * @example
+     *   Seller Business Name AS
+     *
+     * @summary PARTY NAME
+     *
+     * @name cac:PartyName
+     */
+    partyName: Schema.optional(PeppolPartyName),
+    /**
+     * @name cac:PostalAddress
+     */
+    postalAddress: PeppolAddress,
+    /**
+     * @remarks
+     *   Max 1 for a buyer, max 2 for a seller.
+     *
+     * @name cac:PartyTaxScheme
+     *
+     * @cardinality (0..2)
+     */
+    partyTaxSchemes: Schema.optional(Schema.Array(PeppolPartyTaxScheme).check(Schema.isMaxLength(2))),
+    /**
+     * @name cac:PartyLegalEntity
+     */
+    partyLegalEntity: PeppolPartyLegalEntity,
+    /**
+     * @name cac:Contact
+     */
+    contact: Schema.optional(PeppolContact),
+  })
+) {}

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

@@ -0,0 +1,32 @@
+import { Schema } from 'effect';
+
+import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+export class PeppolPartyLegalEntity extends opaque<PeppolPartyLegalEntity>()(
+  Schema.Struct({
+    /**
+     * @example
+     *   987654321;
+     *
+     * @name cbc:CompanyID (+ @schemeID)
+     */
+    companyId: Schema.optional(PeppolIdentifier),
+    /**
+     * @example
+     *   Share capital
+     *
+     * @name cbc:CompanyLegalForm
+     */
+    companyLegalForm: Schema.optional(Schema.String),
+    /**
+     * @example
+     *   Full Formal Seller Name LTD.
+     *
+     * @name cbc:RegistrationName
+     */
+    registrationName: Schema.String,
+  })
+) {}
+
+export type PeppolPartyLegalEntitySchema = PeppolPartyLegalEntity;