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

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

@@ -1,31 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolAmountSchema } from '#/effect/fields/peppol-amount-schema';
-import { peppolLinePriceAllowanceChargeSchema } from '#/effect/fields/peppol-line-price-allowance-charge-schema';
-import { peppolQuantitySchema } from '#/effect/fields/peppol-quantity-schema';
-
-/**
- * @summary Price details on invoice line
- *
- * @name cac:Price
- */
-export const peppolLinePriceSchema = Schema.Struct({
-  /**
-   * @name cac:AllowanceCharge
-   *
-   * @cardinality 0..1
-   */
-  allowanceCharge: Schema.optional(peppolLinePriceAllowanceChargeSchema),
-  /**
-   * @name cbc:BaseQuantity (+ @unitCode)
-   *
-   * @cardinality 0..1
-   */
-  baseQuantity: Schema.optional(peppolQuantitySchema),
-  /**
-   * @name cbc:PriceAmount (+ @currencyID)
-   */
-  priceAmount: peppolAmountSchema,
-});
-
-export type PeppolLinePrice = typeof peppolLinePriceSchema.Type;

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

@@ -1,36 +0,0 @@
-import { Schema } from 'effect';
-
-/**
- * @summary ORDER AND SALES ORDER REFERENCE
- *
- * @name cac:OrderReference
- */
-export const peppolOrderReferenceSchema = 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),
-});
-
-export type PeppolOrderReference = typeof peppolOrderReferenceSchema.Type;

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

@@ -1,138 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolAddressSchema } from '#/effect/fields/peppol-address-schema';
-import { peppolContactSchema } from '#/effect/fields/peppol-contact-schema';
-import { peppolIdentifierSchema } from '#/effect/fields/peppol-identifier-schema';
-import { peppolPartyLegalEntitySchema } from '#/effect/fields/peppol-party-legal-entity-schema';
-import { peppolPartyTaxSchemeSchema } from '#/effect/fields/peppol-party-tax-scheme-schema';
-import { electronicCodesSchema } from '#/effect/values/electronic-codes-schema';
-import { icdCodesSchema } from '#/effect/values/icd-codes-schema';
-
-export const peppolPartyEndpointIdSchema = peppolIdentifierSchema.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 const peppolPartyBaseSchema = 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: peppolPartyEndpointIdSchema,
-  /**
-   * @example
-   *   5060012349998;
-   *
-   * @summary PARTY IDENTIFICATION
-   *
-   * @name `cac:PartyIdentification`
-   */
-  partyIdentification: Schema.optional(
-    Schema.Struct({
-      /**
-       * @description An identifier of the Buyer/seller.
-       *
-       * @summary Buyer/seller identifier
-       *
-       * @name `cbc:ID`
-       */
-      id: peppolIdentifierSchema.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),
-        })
-      ),
-    })
-  ),
-  /**
-   * @example
-   *   Seller Business Name AS
-   *
-   * @summary PARTY NAME
-   *
-   * @name cac:PartyName
-   */
-  partyName: Schema.optional(
-    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,
-    })
-  ),
-  /**
-   * @name cac:PostalAddress
-   */
-  postalAddress: peppolAddressSchema,
-  /**
-   * @remarks
-   *   Max 1 for a buyer, max 2 for a seller.
-   *
-   * @name cac:PartyTaxScheme
-   *
-   * @cardinality (0..2)
-   */
-  partyTaxSchemes: Schema.optional(Schema.Array(peppolPartyTaxSchemeSchema).check(Schema.isMaxLength(2))),
-  /**
-   * @name cac:PartyLegalEntity
-   */
-  partyLegalEntity: peppolPartyLegalEntitySchema,
-  /**
-   * @name cac:Contact
-   */
-  contact: Schema.optional(peppolContactSchema),
-});
-
-export type PeppolPartySchema = typeof peppolPartyBaseSchema.Type;

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

@@ -1,29 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolIdentifierSchema } from '#/effect/fields/peppol-identifier-schema';
-
-export const peppolPartyLegalEntitySchema = Schema.Struct({
-  /**
-   * @example
-   *   987654321;
-   *
-   * @name cbc:CompanyID (+ @schemeID)
-   */
-  companyId: Schema.optional(peppolIdentifierSchema),
-  /**
-   * @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 = typeof peppolPartyLegalEntitySchema.Type;

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

@@ -1,33 +0,0 @@
-import { Effect, Schema } from 'effect';
-
-/**
- * @name cac:PartyTaxScheme (0..2)
- */
-export const peppolPartyTaxSchemeSchema = 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: 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'))),
-  }),
-});
-
-export type PeppolPartyTaxSchema = typeof peppolPartyTaxSchemeSchema.Type;

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

@@ -1,112 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolIdentifierSchema } from '#/effect/fields/peppol-identifier-schema';
-import { icdCodesSchema } from '#/effect/values/icd-codes-schema';
-
-/**
- * @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 const peppolPayeePartySchema = Schema.Struct({
-  /**
-   * @summary PARTY IDENTIFICATION
-   *
-   * @name `cac:PartyIdentification`
-   */
-  partyIdentification: Schema.optional(
-    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(
-        peppolIdentifierSchema.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),
-          })
-        )
-      ),
-    })
-  ),
-  /**
-   * @summary PARTY LEGAL ENTITY
-   *
-   * @name `cac:PartyLegalEntity`
-   */
-  partyLegalEntity: Schema.optional(
-    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(
-        peppolIdentifierSchema.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),
-          })
-        )
-      ),
-    })
-  ),
-  /**
-   * @description The name of the payee.
-   *
-   * @example
-   *   `Payee Name Ltd`;
-   *
-   * @summary Payee name
-   *
-   * @name `cac:PartyName`
-   */
-  partyName: Schema.Struct({ name: Schema.String }),
-});
-
-export type PeppolPayeeParty = typeof peppolPayeePartySchema.Type;

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

@@ -1,210 +0,0 @@
-import { Schema } from 'effect';
-
-import { peppolIsoDateStringSchema } from '#/effect/peppol-iso-date-string-schema';
-import { paymentMeansCodeSchema } from '#/effect/values/payment-means-code-schema';
-
-/**
- * @description A group of business terms providing information about the payment.
- *
- * @summary Payment means (credit transfer/direct debit/card)
- *
- * @name cac:PaymentMeans
- */
-export const peppolPaymentMeansSchema = 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: 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 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(peppolIsoDateStringSchema),
-  /**
-   * @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(
-    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,
-    })
-  ),
-  /**
-   * @description A group of business terms to specify credit transfer payments.
-   *
-   * @summary CREDIT TRANSFER
-   *
-   * @name cac:PayeeFinancialAccount
-   */
-  payeeFinancialAccount: Schema.optional(
-    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(
-        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,
-        })
-      ),
-      /**
-       * @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),
-    })
-  ),
-  /**
-   * @description A group of business terms to specify a direct debit.
-   *
-   * @summary DIRECT DEBIT
-   *
-   * @name cac:PaymentMandate
-   */
-  paymentMandate: Schema.optional(
-    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(
-        Schema.Struct({
-          /**
-           * @description The account to be debited by the direct debit.
-           *
-           * @example
-           *   `12345676543`;
-           *
-           * @summary Debited account identifier
-           *
-           * @name `cbc:ID`
-           */
-          id: Schema.String,
-        })
-      ),
-    })
-  ),
-});
-
-export type PeppolPaymentMeans = typeof peppolPaymentMeansSchema.Type;

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

@@ -1,23 +0,0 @@
-import { Schema } from 'effect';
-
-/**
- * @summary PAYMENT TERMS
- *
- * @name cac:PaymentTerms
- */
-export const peppolPaymentTermsSchema = 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,
-});
-
-export type PeppolPaymentTerms = typeof peppolPaymentTermsSchema.Type;

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

@@ -1,21 +0,0 @@
-import { Schema } from 'effect';
-
-import { quantityUnitCodesSchema } from '#/effect/values/quantity-unit-codes-schema';
-
-/**
- * @summary Quantity with optional unit code
- *
- * @name `cbc:* (+ @unitCode)`
- */
-export const peppolQuantitySchema = Schema.Struct({
-  /**
-   * @name `@unitCode`
-   */
-  unitCode: Schema.optional(quantityUnitCodesSchema),
-  /**
-   * @name `#text (value)`
-   */
-  value: Schema.Finite,
-});
-
-export type PeppolQuantity = typeof peppolQuantitySchema.Type;

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

@@ -1,5 +0,0 @@
-import { Schema } from 'effect';
-
-export const peppolReferenceSchema = Schema.Union([Schema.Struct({ id: Schema.String }), Schema.Undefined]);
-
-export type PeppolReferenceSchema = typeof peppolReferenceSchema.Type;

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

@@ -1,42 +0,0 @@
-import { Effect, Schema } from 'effect';
-
-import { dutyTaxFeeCategorySchema } from '#/effect/values/duty-tax-fee-category-schema';
-
-/**
- * @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 const peppolTaxCategorySchema = Schema.Struct({
-  /**
-   * @description The VAT category code for the invoiced item.
-   *
-   * @summary Invoiced item VAT category code
-   *
-   * @name `cbc:ID`
-   */
-  id: dutyTaxFeeCategorySchema,
-  /**
-   * @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: Schema.Struct({
-    /**
-     * @name `cbc:ID`
-     */
-    id: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('VAT'))),
-  }),
-});
-
-export type PeppolTaxCategory = typeof peppolTaxCategorySchema.Type;