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

package/src/schemas/fields/peppol-party-tax-scheme-schema.ts

@@ -0,0 +1,41 @@
+import { Effect, Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+
+class PeppolTaxSchemeId extends opaque<PeppolTaxSchemeId>()(
+  Schema.Struct({
+    /**
+     * @description Mandatory element. For Seller VAT identifier (BT-31), use value “VAT”, for the seller tax registration identifier (BT-32), use != "VAT"
+     *
+     * @name cbc:ID
+     */
+    id: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('VAT'))),
+  })
+) {}
+
+/**
+ * @name cac:PartyTaxScheme (0..2)
+ */
+export class PeppolPartyTaxScheme extends opaque<PeppolPartyTaxScheme>()(
+  Schema.Struct({
+    /**
+     * @description The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of
+     * the Seller for tax purposes or a reference that enables the Seller to state his registered tax status. In order for the buyer to automatically
+     * identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31)
+     * shall be present.
+     *
+     * @summary Seller VAT identifier, Seller tax registration identifier
+     *
+     * @name `cbc:CompanyID`
+     */
+    companyId: Schema.String,
+    /**
+     * @description Mandatory element. For Seller VAT identifier (BT-31), use value “VAT”, for the seller tax registration identifier (BT-32), use != "VAT"
+     *
+     * @name `cac:TaxScheme`
+     */
+    taxSchemeId: PeppolTaxSchemeId,
+  })
+) {}
+
+export type PeppolPartyTaxSchema = PeppolPartyTaxScheme;

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

@@ -0,0 +1,119 @@
+import { Schema } from 'effect';
+
+import { PeppolIdentifier } from '#/schemas/fields/peppol-identifier-schema';
+import { opaque } from '#/schemas/utils/opaque';
+import { icdCodesSchema } from '#/schemas/values/icd-codes-schema';
+
+class PeppolPartyName extends opaque<PeppolPartyName>()(Schema.Struct({ name: Schema.String })) {}
+
+class PeppolPartyLegalEntity extends opaque<PeppolPartyLegalEntity>()(
+  Schema.Struct({
+    /**
+     * @description An identifier issued by an official registrar that identifies the payee as a legal entity or person.
+     *
+     * @example
+     *   `FR932874294`;
+     *
+     * @summary Payee legal registration identifier
+     *
+     * @name `cbc:CompanyID`
+     */
+    companyId: Schema.optional(
+      PeppolIdentifier.pipe(
+        Schema.fieldsAssign({
+          /**
+           * @description An identifier issued by an official registrar that identifies the payee as a legal entity or person.
+           *
+           * @example
+           *   `FR932874294`;
+           *
+           * @summary Payee legal registration identifier
+           *
+           * @name `#text`
+           */
+          id: Schema.String,
+          /**
+           * @description The identification scheme identifier of the Payee legal registration identifier.
+           *
+           * @summary Payee legal registration identifier identification scheme identifier
+           *
+           * @name `@schemeID`
+           */
+          schemeId: Schema.optional(icdCodesSchema),
+        })
+      )
+    ),
+  })
+) {}
+
+class PeppolPartyIdentification extends opaque<PeppolPartyIdentification>()(
+  Schema.Struct({
+    /**
+     * @description This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee
+     * bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.
+     *
+     * @summary Payee identifier or bank assigned crditor identifier
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.optional(
+      PeppolIdentifier.pipe(
+        Schema.fieldsAssign({
+          /**
+           * @description This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee
+           * bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.
+           *
+           * @summary Payee identifier or bank assigned crditor identifier
+           *
+           * @name `#text`
+           */
+          id: Schema.String,
+          /**
+           * @description The identification scheme identifier of the payee identifier. For bank assigned creditor identifier (BT-90), value MUST be "SEPA"
+           *
+           * @summary Payee or bank assigned creditor identifier identification scheme identifier
+           *
+           * @name `@schemeID`
+           */
+          schemeId: Schema.optional(Schema.String),
+        })
+      )
+    ),
+  })
+) {}
+
+/**
+ * @description A group of business terms providing information about the Payee, i.e. the role that received the payment. Shall be used wwhen the payee is
+ * different from the seller.
+ *
+ * @summary PAYEE
+ *
+ * @name cac:PayeeParty
+ */
+export class PeppolPayeeParty extends opaque<PeppolPayeeParty>()(
+  Schema.Struct({
+    /**
+     * @summary PARTY IDENTIFICATION
+     *
+     * @name `cac:PartyIdentification`
+     */
+    partyIdentification: Schema.optional(PeppolPartyIdentification),
+    /**
+     * @summary PARTY LEGAL ENTITY
+     *
+     * @name `cac:PartyLegalEntity`
+     */
+    partyLegalEntity: Schema.optional(PeppolPartyLegalEntity),
+    /**
+     * @description The name of the payee.
+     *
+     * @example
+     *   `Payee Name Ltd`;
+     *
+     * @summary Payee name
+     *
+     * @name `cac:PartyName`
+     */
+    partyName: PeppolPartyName,
+  })
+) {}

package/src/schemas/fields/peppol-payment-means-schema.ts

@@ -0,0 +1,224 @@
+import { Schema } from 'effect';
+
+import { PeppolIsoDateString } from '#/schemas/peppol-iso-date-string';
+import { opaque } from '#/schemas/utils/opaque';
+import { paymentMeansCodeSchema } from '#/schemas/values/payment-means-code-schema';
+
+class PeppolPaymentMandatePayerFinancialAccountId extends opaque<PeppolPaymentMandatePayerFinancialAccountId>()(
+  Schema.Struct({
+    /**
+     * @description The account to be debited by the direct debit.
+     *
+     * @example
+     *   `12345676543`;
+     *
+     * @summary Debited account identifier
+     *
+     * @name `cbc:ID`
+     */
+    id: Schema.String,
+  })
+) {}
+
+class PeppolPaymentMandate extends opaque<PeppolPaymentMandate>()(
+  Schema.Struct({
+    /**
+     * @description Unique identifier assigned by the Payee for referencing the direct debit mandate. Used in order to pre-notify the Buyer of a SEPA direct debit.
+     *
+     * @summary Mandate reference identifier
+     *
+     * @name cbc:ID
+     */
+    id: Schema.optional(Schema.String),
+    /**
+     * @description The account to be debited by the direct debit.
+     *
+     * @example
+     *   `12345676543`;
+     *
+     * @summary Debited account identifier
+     *
+     * @name `cac:PayerFinancialAccount`
+     */
+    payerFinancialAccountId: Schema.optional(PeppolPaymentMandatePayerFinancialAccountId),
+  })
+) {}
+
+class PeppolPayeeFinancialAccountFinancialInstitutionBranch extends opaque<PeppolPayeeFinancialAccountFinancialInstitutionBranch>()(
+  Schema.Struct({
+    /**
+     * @description An identifier for the payment service provider where a payment account is located. Such as a BIC or a national clearing code where required. No
+     * identification scheme Identifier to be used.
+     *
+     * @example
+     *   `9998`;
+     *
+     * @summary Payment service provider identifier
+     *
+     * @name `cac:FinancialInstitutionBranch`
+     */
+    id: Schema.String,
+  })
+) {}
+
+class PeppolPayeeFinancialAccount extends opaque<PeppolPayeeFinancialAccount>()(
+  Schema.Struct({
+    /**
+     * @description An identifier for the payment service provider where a payment account is located. Such as a BIC or a national clearing code where required. No
+     * identification scheme Identifier to be used.
+     *
+     * @example
+     *   `9998`;
+     *
+     * @summary Payment service provider identifier
+     *
+     * @name `cac:FinancialInstitutionBranch`
+     */
+    financialInstitutionBranch: Schema.optional(PeppolPayeeFinancialAccountFinancialInstitutionBranch),
+    /**
+     * @description A unique identifier of the financial payment account, at a payment service provider, to which payment should be made. Such as IBAN or BBAN.
+     *
+     * @summary Payment account identifier
+     *
+     * @name cbc:ID
+     */
+    id: Schema.String,
+    /**
+     * @description The name of the payment account, at a payment service provider, to which payment should be made.
+     *
+     * @summary Payment account name
+     *
+     * @name cbc:Name
+     */
+    name: Schema.optional(Schema.String),
+  })
+) {}
+
+class PeppolCardAccount extends opaque<PeppolCardAccount>()(
+  Schema.Struct({
+    /**
+     * @description The name of the payment card holder.
+     *
+     * @summary Payment card holder name
+     *
+     * @name cbc:HolderName
+     */
+    holderName: Schema.optional(Schema.String),
+    /**
+     * @summary Syntax required element not related to a business term.
+     *
+     * @name cbc:NetworkID
+     */
+    networkId: Schema.String,
+    /**
+     * @description The Primary Account Number (PAN) of the card used for payment. In accordance with card payments security standards, an invoice should never
+     * include a full card primary account number.
+     *
+     * @example
+     *   `1234`;
+     *
+     * @summary Payment card primary account number
+     *
+     * @name cbc:PrimaryAccountNumberID
+     */
+    primaryAccountNumberId: Schema.String,
+  })
+) {}
+
+class PeppolPaymentMeansCode extends opaque<PeppolPaymentMeansCode>()(
+  Schema.Struct({
+    /**
+     * @description The means, expressed as code, for how a payment is expected to be or has been settled.
+     *
+     * @example
+     *   30;
+     *
+     * @summary Payment means type code
+     *
+     * @name `#text`
+     */
+    code: paymentMeansCodeSchema,
+    /**
+     * @description The means, expressed as text, for how a payment is expected to be or has been settled.
+     *
+     * @example
+     *   Credit transfer
+     *
+     * @summary Payment means text
+     *
+     * @name `@name`
+     */
+    name: Schema.optional(Schema.String),
+  })
+) {}
+
+/**
+ * @description A group of business terms providing information about the payment.
+ *
+ * @summary Payment means (credit transfer/direct debit/card)
+ *
+ * @name cac:PaymentMeans
+ */
+export class PeppolPaymentMeans extends opaque<PeppolPaymentMeans>()(
+  Schema.Struct({
+    /**
+     * @description The means, expressed as code, for how a payment is expected to be or has been settled.
+     *
+     * @example
+     *   30;
+     *
+     * @summary Payment means type code
+     *
+     * @name `cbc:PaymentMeansCode`
+     */
+    paymentMeansCode: PeppolPaymentMeansCode,
+    /**
+     * @description The date when the payment is due.Format "YYYY-MM-DD". In case the Amount due for payment (BT-115) is positive, either the Payment due date
+     * (BT-9) or the Payment terms (BT-20) shall be present.
+     *
+     * @remarks
+     *   This should only be used with a credit note.
+     *
+     * @summary Payment due date
+     *
+     * @name `cbc:PaymentDueDate`
+     */
+    paymentDueDate: Schema.optional(PeppolIsoDateString),
+    /**
+     * @description A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation
+     * information. This information element helps the Seller to assign an incoming payment to the relevant payment process.
+     *
+     * @example
+     *   `432948234234234`;
+     *
+     * @summary Remittance information
+     *
+     * @name cbc:PaymentID
+     */
+    paymentId: Schema.optional(Schema.String),
+    /**
+     * @description A group of business terms providing information about card used for payment contemporaneous with invoice issuance.
+     *
+     * @summary PAYMENT CARD INFORMATION
+     *
+     * @name cac:CardAccount
+     */
+    cardAccount: Schema.optional(PeppolCardAccount),
+    /**
+     * @description A group of business terms to specify credit transfer payments.
+     *
+     * @summary CREDIT TRANSFER
+     *
+     * @name cac:PayeeFinancialAccount
+     */
+    payeeFinancialAccount: Schema.optional(PeppolPayeeFinancialAccount),
+    /**
+     * @description A group of business terms to specify a direct debit.
+     *
+     * @summary DIRECT DEBIT
+     *
+     * @name cac:PaymentMandate
+     */
+    paymentMandate: Schema.optional(PeppolPaymentMandate),
+  })
+) {}

package/src/schemas/fields/peppol-payment-terms-schema.ts

@@ -0,0 +1,25 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+
+/**
+ * @summary PAYMENT TERMS
+ *
+ * @name cac:PaymentTerms
+ */
+export class PeppolPaymentTerms extends opaque<PeppolPaymentTerms>()(
+  Schema.Struct({
+    /**
+     * @description A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). In case the
+     * Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
+     *
+     * @example
+     *   Net within 30 days
+     *
+     * @summary Payment terms
+     *
+     * @name cbc:Note
+     */
+    note: Schema.String,
+  })
+) {}

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

@@ -0,0 +1,22 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+import { quantityUnitCodesSchema } from '#/schemas/values/quantity-unit-codes-schema';
+
+/**
+ * @summary Quantity with optional unit code
+ *
+ * @name `cbc:* (+ @unitCode)`
+ */
+export class PeppolQuantity extends opaque<PeppolQuantity>()(
+  Schema.Struct({
+    /**
+     * @name `@unitCode`
+     */
+    unitCode: Schema.optional(quantityUnitCodesSchema),
+    /**
+     * @name `#text (value)`
+     */
+    value: Schema.Finite,
+  })
+) {}

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

@@ -0,0 +1,9 @@
+import { Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+
+class PeppolReferenceId extends opaque<PeppolReferenceId>()(Schema.Struct({ id: Schema.String })) {}
+
+export const peppolReferenceSchema = Schema.Union([PeppolReferenceId, Schema.Undefined]);
+
+export type PeppolReferenceSchema = typeof peppolReferenceSchema.Type;

package/src/schemas/fields/peppol-tax-category-schema.ts

@@ -0,0 +1,47 @@
+import { Effect, Schema } from 'effect';
+
+import { opaque } from '#/schemas/utils/opaque';
+import { peppolDutyTaxFeeCategorySchema } from '#/schemas/values/duty-tax-fee-category-schema';
+
+export class PeppolTaxSchemeId extends opaque<PeppolTaxSchemeId>()(
+  Schema.Struct({
+    /**
+     * @name `cbc:ID`
+     */
+    id: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('VAT'))),
+  })
+) {}
+
+/**
+ * @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:TaxCategory`
+ */
+export class PeppolTaxCategory extends opaque<PeppolTaxCategory>()(
+  Schema.Struct({
+    /**
+     * @description The VAT category code for the invoiced item.
+     *
+     * @summary Invoiced item VAT category code
+     *
+     * @name `cbc:ID`
+     */
+    id: peppolDutyTaxFeeCategorySchema,
+    /**
+     * @description The VAT rate, represented as percentage that applies to the invoiced item.
+     *
+     * @summary Invoiced item VAT rate
+     *
+     * @name `cbc:Percent`
+     */
+    percent: Schema.optional(Schema.Finite),
+    /**
+     * @default VAT
+     *
+     * @name `cac:TaxScheme`
+     */
+    taxSchemeId: PeppolTaxSchemeId,
+  })
+) {}

package/src/schemas/fields/peppol-tax-representative-schema.ts

@@ -0,0 +1,26 @@
+import { Schema } from 'effect';
+
+import { PeppolAddress } from '#/schemas/fields/peppol-address-schema';
+import { PeppolPartyTaxScheme } from '#/schemas/fields/peppol-party-tax-scheme-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+/**
+ * @summary SELLER TAX REPRESENTATIVE PARTY
+ *
+ * @name cac:TaxRepresentativeParty
+ */
+export class PeppolTaxRepresentative extends opaque<PeppolTaxRepresentative>()(
+  Schema.Struct({
+    /**
+     * @name cac:PartyName/cbc:Name
+     */
+    name: Schema.String,
+    /**
+     * @name cac:PostalAddress
+     */
+    postalAddress: PeppolAddress,
+    partyTaxScheme: PeppolPartyTaxScheme,
+  })
+) {}
+
+export type PeppolTaxRepresentativeParty = PeppolTaxRepresentative;

package/src/{effect → schemas}/fields/peppol-tax-subtotal-category-schema.ts

@@ -1,6 +1,7 @@
 import { Schema } from 'effect';
 
-import { peppolTaxCategorySchema } from '#/effect/fields/peppol-tax-category-schema';
+import { PeppolTaxCategory } from '#/schemas/fields/peppol-tax-category-schema';
+import { opaque } from '#/schemas/utils/opaque';
 
 /**
  * @description This one is specific for TaxSubtotal since it includes more fields.
@@ -9,8 +10,9 @@ import { peppolTaxCategorySchema } from '#/effect/fields/peppol-tax-category-sch
  *
  * @name cac:TaxCategory
  */
-export const peppolTaxSubtotalCategorySchema = peppolTaxCategorySchema.pipe(
-  Schema.fieldsAssign({
+export class PeppolTaxSubTotalCategory extends opaque<PeppolTaxSubTotalCategory>()(
+  Schema.Struct({
+    ...PeppolTaxCategory.fields,
     /**
      * @description The reason for the tax exemption.
      *
@@ -24,6 +26,6 @@ export const peppolTaxSubtotalCategorySchema = peppolTaxCategorySchema.pipe(
      */
     taxExemptionReasonCode: Schema.optional(Schema.String),
   })
-);
+) {}
 
-export type PeppolTaxSubTotalCategory = typeof peppolTaxSubtotalCategorySchema.Type;
+export interface PeppolTaxSubTotalCategoryEncoded extends Schema.Codec.Encoded<typeof PeppolTaxSubTotalCategory> {}

package/src/schemas/fields/peppol-tax-subtotal-schema.ts

@@ -0,0 +1,33 @@
+import { Schema } from 'effect';
+
+import { PeppolAmount } from '#/schemas/fields/peppol-amount-schema';
+import { PeppolTaxSubTotalCategory } from '#/schemas/fields/peppol-tax-subtotal-category-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+/**
+ * @summary VAT breakdown (TaxSubtotal)
+ *
+ * @name cac:TaxSubtotal
+ */
+export class PeppolTaxSubTotal extends opaque<PeppolTaxSubTotal>()(
+  Schema.Struct({
+    /**
+     * @description The amount of tax for the tax subtotal.
+     *
+     * @name `cbc:TaxAmount (+ @currencyID)`
+     */
+    taxAmount: PeppolAmount,
+    /**
+     * @description The tax category associated with this tax subtotal.
+     *
+     * @name cac:TaxCategory
+     */
+    taxCategory: PeppolTaxSubTotalCategory,
+    /**
+     * @description The taxable amount for the tax subtotal.
+     *
+     * @name `cbc:TaxableAmount (+ @currencyID)`
+     */
+    taxableAmount: PeppolAmount,
+  })
+) {}

package/src/schemas/fields/peppol-tax-totals-base-schema.ts

@@ -0,0 +1,28 @@
+import { Schema } from 'effect';
+
+import { PeppolAmount } from '#/schemas/fields/peppol-amount-schema';
+import { PeppolTaxSubTotal } from '#/schemas/fields/peppol-tax-subtotal-schema';
+import { opaque } from '#/schemas/utils/opaque';
+
+/**
+ * @summary TAX TOTAL
+ *
+ * @name cac:TaxTotal (1..2)
+ */
+export class PeppolTaxTotalsBase extends opaque<PeppolTaxTotalsBase>()(
+  Schema.Struct({
+    /**
+     * @example
+     *   200;
+     *
+     * @name cbc:TaxAmount (+ @currencyID)
+     */
+    taxAmount: PeppolAmount,
+    /**
+     * @name cac:TaxSubtotal (0..n)
+     */
+    taxSubtotals: Schema.optional(Schema.Array(PeppolTaxSubTotal)),
+  })
+) {}
+
+export type PeppolTaxTotal = PeppolTaxTotalsBase;