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

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

@@ -0,0 +1,104 @@
+import { Effect, Schema } from 'effect';
+
+import { BaseLineAllowanceCharge } from '#/schemas/fields/peppol-line-allowance-charge-schema';
+import { PeppolTaxCategory } from '#/schemas/fields/peppol-tax-category-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';
+import { peppolDutyTaxFeeCategorySchema } from '#/schemas/values/duty-tax-fee-category-schema';
+
+export class PeppolTaxCategoryTaxSchemeId extends opaque<PeppolTaxCategoryTaxSchemeId>()(
+  Schema.Struct({
+    /**
+     * @description Mandatory element. Use "VAT"
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('VAT'))),
+  })
+) {}
+
+export class BaseAllowanceCharge extends opaque<BaseAllowanceCharge>()(
+  Schema.Struct({
+    ...BaseLineAllowanceCharge.fields,
+    /**
+     * @summary TAX CATEGORY
+     *
+     * @name cac:TaxCategory
+     */
+    taxCategory: Schema.optional(
+      PeppolTaxCategory.pipe(
+        Schema.fieldsAssign({
+          /**
+           * @description A coded identification of what VAT category applies to the document level allowance or charge.
+           *
+           * @summary Document level allowance or charge VAT category code
+           *
+           * @name `cbc:ID`
+           */
+          id: peppolDutyTaxFeeCategorySchema,
+          /**
+           * @description The VAT rate, represented as percentage that applies to the document level allowance or charge.
+           *
+           * @summary Document level allowance or charge VAT rate
+           *
+           * @name `cbc:Percent`
+           */
+          percent: Schema.optional(Schema.Finite),
+          /**
+           * @default VAT
+           *
+           * @name `cac:TaxScheme`
+           */
+          taxSchemeId: PeppolTaxCategoryTaxSchemeId,
+        })
+      )
+    ),
+  })
+) {}
+
+export class PeppolAllowance extends opaque<PeppolAllowance>()(
+  Schema.Struct({
+    ...BaseAllowanceCharge.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 PeppolCharge extends opaque<PeppolCharge>()(
+  Schema.Struct({
+    ...BaseAllowanceCharge.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'",
+    }),
+  })
+) {}
+
+/**
+ * @summary Allowance/Charge
+ *
+ * @name cac:AllowanceCharge
+ */
+export const peppolAllowanceChargeSchema = Schema.Union([PeppolAllowance, PeppolCharge]).annotate({ message: 'unable to decode allowance charge' });
+
+export type PeppolAllowanceCharge = Schema.Schema.Type<typeof peppolAllowanceChargeSchema>;
+export type PeppolAllowanceChargeEncoded = Schema.Codec.Encoded<typeof peppolAllowanceChargeSchema>;

package/src/schemas/fields/peppol-amount-schema.ts

@@ -0,0 +1,23 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+import { currencyCodeSchema } from '#/schemas/values/currency-code-schema';
+
+/**
+ * @summary Monetary amount with mandatory currency
+ *
+ * @name cbc:* (+ @currencyID)
+ */
+export class PeppolAmount extends opaque<PeppolAmount>()(
+  Schema.Struct({
+    /**
+     * @name \@currencyID
+     */
+    currencyId: currencyCodeSchema,
+    /**
+     * @name #text (value)
+     */
+    value: Schema.Finite,
+  })
+) {}
+export interface PeppolAmountEncoded extends Schema.Codec.Encoded<typeof PeppolAmount> {}

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

@@ -0,0 +1,141 @@
+import { Effect, Schema } from 'effect';
+
+import { PeppolAmount } from '#/schemas/fields/peppol-amount-schema';
+import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema';
+import { PeppolInvoiceLinePeriod } from '#/schemas/fields/peppol-invoice-line-period-schema';
+import { peppolLineAllowanceChargeSchema } from '#/schemas/fields/peppol-line-allowance-charge-schema';
+import { PeppolLineItem } from '#/schemas/fields/peppol-line-item-schema';
+import { PeppolLinePrice } from '#/schemas/fields/peppol-line-price-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+export class PeppolOrderLineReference extends opaque<PeppolOrderLineReference>()(Schema.Struct({ lineId: Schema.String })) {}
+
+/**
+ * @description Base of the invoice line and credit note line schemas.
+ */
+export class PeppolBaseLine extends opaque<PeppolBaseLine>()(
+  Schema.Struct({
+    /**
+     * @description A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
+     *
+     * @example
+     *   `1287:65464`;
+     *
+     * @summary Invoice line Buyer accounting reference
+     *
+     * @name cbc:AccountingCost
+     *
+     * @cardinality 0..1
+     */
+    accountingCost: Schema.optional(Schema.String),
+    /**
+     * @description A group of business terms providing information about allowances or charges applicable to the individual Invoice line.
+     *
+     * @summary Invoice line allowances or charges
+     *
+     * @name cac:AllowanceCharge
+     *
+     * @cardinality 0..n
+     */
+    allowanceCharges: Schema.optional(Schema.Array(peppolLineAllowanceChargeSchema)),
+    /**
+     * @summary Line object identifier
+     *
+     * @name cac:DocumentReference
+     *
+     * @cardinality 0..1
+     */
+    documentReference: Schema.optional(
+      Schema.Array(
+        PeppolIdentifier.pipe(
+          Schema.fieldsAssign({
+            /**
+             * @default 130
+             *
+             * @name cbc:DocumentTypeCode
+             */
+            documentTypeCode: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('130'))),
+          })
+        )
+      )
+    ),
+    /**
+     * @description A unique identifier for the individual line within the Invoice.
+     *
+     * @example
+     *   12;
+     *
+     * @summary Invoice line identifier
+     *
+     * @name cbc:ID
+     *
+     * @cardinality 1..1
+     */
+    id: Schema.String,
+    /**
+     * @description A group of business terms providing information about the period relevant for the Invoice line.
+     *
+     * @summary Invoice line period
+     *
+     * @name cac:InvoicePeriod
+     *
+     * @cardinality 0..1
+     */
+    invoicePeriod: Schema.optional(PeppolInvoiceLinePeriod),
+    /**
+     * @description A group of business terms providing information about the goods and services invoiced.
+     *
+     * @summary Item information
+     *
+     * @name cac:Item
+     *
+     * @cardinality 1..1
+     */
+    item: PeppolLineItem,
+    /**
+     * @description The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other
+     * relevant taxes. Must be rounded to maximum 2 decimals.
+     *
+     * @example
+     *   { value: 2145.0, currencyId: "EUR" }
+     *
+     * @summary Invoice line net amount
+     *
+     * @name cbc:LineExtensionAmount (+ @currencyID)
+     *
+     * @cardinality 1..1
+     */
+    lineExtensionAmount: PeppolAmount,
+    /**
+     * @description A textual note that gives unstructured information that is relevant to the Invoice line.
+     *
+     * @example
+     *   New article number 12345
+     *
+     * @summary Invoice line note
+     *
+     * @name cbc:Note
+     *
+     * @cardinality 0..1
+     */
+    note: Schema.optional(Schema.String),
+    /**
+     * @summary Order line reference
+     *
+     * @name cac:OrderLineReference
+     *
+     * @cardinality 0..1
+     */
+    orderLineReference: Schema.optional(PeppolOrderLineReference),
+    /**
+     * @description A group of business terms providing information about the price applied for the goods and services invoices on the Invoice line.
+     *
+     * @summary Price Details
+     *
+     * @name cac:Price
+     *
+     * @cardinality 1..1
+     */
+    price: PeppolLinePrice,
+  })
+) {}

package/src/{effect → schemas}/fields/peppol-billing-reference-schema.ts

@@ -1,22 +1,10 @@
 import { Schema } from 'effect';
 
-import { peppolIsoDateStringSchema } from '#/effect/peppol-iso-date-string-schema';
+import { PeppolIsoDateString } from '#/schemas/peppol-iso-date-string';
+import { opaque } from '#/schemas/utils/opaque';
 
-/**
- * @summary PRECEDING INVOICE REFERENCE (0..n)
- *
- * @name cac:BillingReference
- */
-export const peppolBillingReferenceSchema = Schema.Struct({
-  /**
-   * @example
-   *   inv123;
-   *
-   * @summary INVOICE DOCUMENT REFERENCE
-   *
-   * @name `cac:InvoiceDocumentReference`
-   */
-  invoiceDocumentReference: Schema.Struct({
+class PeppolInvoiceDocumentReference extends opaque<PeppolInvoiceDocumentReference>()(
+  Schema.Struct({
     /**
      * @description The identification of an Invoice that was previously sent by the seller.
      *
@@ -40,8 +28,25 @@ export const peppolBillingReferenceSchema = Schema.Struct({
      *
      * @name `cbc:IssueDate`
      */
-    issueDate: Schema.optional(peppolIsoDateStringSchema),
-  }),
-});
+    issueDate: Schema.optional(PeppolIsoDateString),
+  })
+) {}
 
-export type PeppolBillingReference = typeof peppolBillingReferenceSchema.Type;
+/**
+ * @summary PRECEDING INVOICE REFERENCE (0..n)
+ *
+ * @name cac:BillingReference
+ */
+export class PeppolBillingReference extends opaque<PeppolBillingReference>()(
+  Schema.Struct({
+    /**
+     * @example
+     *   inv123;
+     *
+     * @summary INVOICE DOCUMENT REFERENCE
+     *
+     * @name `cac:InvoiceDocumentReference`
+     */
+    invoiceDocumentReference: PeppolInvoiceDocumentReference,
+  })
+) {}

package/src/schemas/fields/peppol-binary-object-schema.ts

@@ -0,0 +1,52 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+import { peppolBase64Schema } from '#/schemas/utils/peppol-base-64-schema';
+import { mimeCodesSchema } from '#/schemas/values/mime-codes-schema';
+
+// RFC 4648 §5 — Base64url Encoding: URL/file-safe alphabet (A-Z a-z 0-9 - _), optional `=` padding.
+// Effect port of `z.base64url()`: keeps the value as a plain string and only validates the shape.
+const base64UrlSchema = Schema.String.check(Schema.isPattern(/^[A-Za-z0-9\-_]+={0,2}$/)).annotate({ message: 'Invalid base64url' });
+
+/**
+ * @summary Binary object for attachments
+ *
+ * @name cbc:EmbeddedDocumentBinaryObject (+ @mimeCode, @filename)
+ */
+export class PeppolBinaryObject extends opaque<PeppolBinaryObject>()(
+  Schema.Struct({
+    /**
+     * @description An attached document embedded as binary object (Base64) or sent together with the invoice.
+     *
+     * @example
+     *   aHR0cHM6Ly90ZXN0LXZlZmEuZGlmaS5uby9wZXBwb2xiaXMvcG9hY2MvYmlsbGluZy8zLjAvYmlzLw==
+     *
+     * @summary Attached document
+     *
+     * @name `#text` (Base64 content)
+     */
+    content: Schema.Union([peppolBase64Schema, base64UrlSchema]),
+    /**
+     * @description The mime code of the attached document.
+     *
+     * @example
+     *   text / csv;
+     *
+     * @summary Attached document Mime code
+     *
+     * @name `@mimeCode`
+     */
+    mimeCode: mimeCodesSchema,
+    /**
+     * @description The file name of the attached document.
+     *
+     * @example
+     *   Hours - spent.csv;
+     *
+     * @summary Attached document Filename
+     *
+     * @name `@filename`
+     */
+    filename: Schema.String,
+  })
+) {}

package/src/schemas/fields/peppol-contact-schema.ts

@@ -0,0 +1,20 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+
+export class PeppolContact extends opaque<PeppolContact>()(
+  Schema.Struct({
+    /**
+     * @name cbc:ElectronicMail
+     */
+    electronicMail: Schema.optional(Schema.String),
+    /**
+     * @name cbc:Name
+     */
+    name: Schema.optional(Schema.String),
+    /**
+     * @name cbc:Telephone
+     */
+    telephone: Schema.optional(Schema.String),
+  })
+) {}

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

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

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

@@ -0,0 +1,109 @@
+import { Schema } from 'effect';
+
+import { PeppolIsoDateString } from '#/schemas/peppol-iso-date-string';
+import { opaque } from '#/schemas/utils/opaque';
+import { icdCodesSchema } from '#/schemas/values/icd-codes-schema';
+
+import { PeppolAddress } from './peppol-address-schema';
+import { PeppolIdentifier } from './peppol-identifier-schema';
+
+class PeppolDeliveryPartyPartyName extends opaque<PeppolDeliveryPartyPartyName>()(
+  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,
+  })
+) {}
+
+class PeppolDeliveryParty extends opaque<PeppolDeliveryParty>()(
+  Schema.Struct({
+    /**
+     * @summary PARTY NAME
+     *
+     * @name `cac:PartyName`
+     */
+    partyName: PeppolDeliveryPartyPartyName,
+  })
+) {}
+
+class PeppolDeliveryLocation extends opaque<PeppolDeliveryLocation>()(
+  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(
+      PeppolIdentifier.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(PeppolAddress),
+  })
+) {}
+
+export class PeppolDelivery extends opaque<PeppolDelivery>()(
+  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(PeppolIsoDateString),
+    /**
+     * @name `cac:DeliveryLocation`
+     */
+    deliveryLocation: Schema.optional(PeppolDeliveryLocation),
+
+    /**
+     * @summary Delivery party
+     *
+     * @name `cac:DeliveryParty`
+     */
+    deliveryParty: Schema.optional(PeppolDeliveryParty),
+  })
+) {}

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

@@ -0,0 +1,21 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+
+/**
+ * @summary Identifier with optional scheme
+ *
+ * @name `cbc:ID (+ optional @schemeID)`
+ */
+export class PeppolIdentifier extends opaque<PeppolIdentifier>()(
+  Schema.Struct({
+    /**
+     * @name cbc:ID
+     */
+    id: Schema.String,
+    /**
+     * @name `@schemeID`
+     */
+    schemeId: Schema.optional(Schema.String),
+  })
+) {}

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

@@ -0,0 +1,35 @@
+import { Schema } from 'effect';
+
+import { PeppolIsoDateString } from '#/schemas/peppol-iso-date-string';
+import { opaque } from '#/schemas/utils/opaque';
+
+export class PeppolInvoiceLinePeriod extends opaque<PeppolInvoiceLinePeriod>()(
+  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(PeppolIsoDateString),
+    /**
+     * @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(PeppolIsoDateString),
+  })
+) {}

package/src/{effect → schemas}/fields/peppol-invoice-line-schema.ts

@@ -1,16 +1,18 @@
 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';
+import { PeppolBaseLine } from '#/schemas/fields/peppol-base-line-schema';
+import { PeppolQuantity } from '#/schemas/fields/peppol-quantity-schema';
+import { opaque } from '#/schemas/utils/opaque';
+import { quantityUnitCodesSchema } from '#/schemas/values/quantity-unit-codes-schema';
 
 /**
  * @summary Invoice line
  *
  * @name cac:InvoiceLine
  */
-export const peppolInvoiceLineSchema = peppolBaseLineSchema.pipe(
-  Schema.fieldsAssign({
+export class PeppolInvoiceLine extends opaque<PeppolInvoiceLine>()(
+  Schema.Struct({
+    ...PeppolBaseLine.fields,
     /**
      * @description The quantity of items (goods or services) that is charged in the Invoice line.
      *
@@ -21,7 +23,7 @@ export const peppolInvoiceLineSchema = peppolBaseLineSchema.pipe(
      *
      * @name cbc:InvoicedQuantity (+ @unitCode)
      */
-    invoicedQuantity: peppolQuantitySchema.pipe(
+    invoicedQuantity: PeppolQuantity.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
@@ -40,7 +42,5 @@ export const peppolInvoiceLineSchema = peppolBaseLineSchema.pipe(
       })
     ),
   })
-);
-
-export interface PeppolInvoiceLine extends Schema.Schema.Type<typeof peppolInvoiceLineSchema> {}
-export interface PeppolInvoiceLineEncoded extends Schema.Codec.Encoded<typeof peppolInvoiceLineSchema> {}
+) {}
+export interface PeppolInvoiceLineEncoded extends Schema.Codec.Encoded<typeof PeppolInvoiceLine> {}

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

@@ -0,0 +1,31 @@
+import { Schema } from 'effect';
+
+import { PeppolInvoiceLinePeriod } from '#/schemas/fields/peppol-invoice-line-period-schema';
+import { opaque } from '#/schemas/utils/opaque';
+import { vatDateCodeSchema } from '#/schemas/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 class PeppolInvoicePeriod extends opaque<PeppolInvoicePeriod>()(
+  PeppolInvoiceLinePeriod.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),
+    })
+  )
+) {}