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

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

@@ -1,131 +0,0 @@
-import * as z from 'zod/mini';
-
-import { addressSchema } from '#/schemas/fields/address-schema';
-import { contactSchema } from '#/schemas/fields/contact-schema';
-import { identifierSchema } from '#/schemas/fields/identifier-schema';
-import { partyLegalEntitySchema } from '#/schemas/fields/party-legal-entity-schema';
-import { partyTaxSchemeSchema } from '#/schemas/fields/party-tax-schema';
-import { electronicCodesSchema } from '#/schemas/values/eas-codes';
-import { icdCodesSchema } from '#/schemas/values/icd-codes';
-
-/**
- * @summary Party common substructure
- *
- * @name cac:Party
- */
-export const partyBaseSchema = z.object({
-  /**
-   * @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: z.safeExtend(identifierSchema(), {
-    /**
-     * @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: z.string(),
-    /**
-     * @description The identification scheme identifier of the Seller/Buyer electronic address.
-     *
-     * @summary Seller/Buyer electronic address identification scheme identifier
-     *
-     * @name `@schemeID`
-     */
-    schemeId: electronicCodesSchema(),
-  }),
-  /**
-   * @example
-   *   5060012349998;
-   *
-   * @summary PARTY IDENTIFICATION
-   *
-   * @name `cac:PartyIdentification`
-   */
-  partyIdentification: z.optional(
-    z.object({
-      /**
-       * @description An identifier of the Buyer/seller.
-       *
-       * @summary Buyer/seller identifier
-       *
-       * @name `cbc:ID`
-       */
-      id: z.safeExtend(identifierSchema(), {
-        /**
-         * @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: z.string(),
-        /**
-         * @description The identification scheme identifier of the Seller/Buyer electronic address.
-         *
-         * @summary Seller/Buyer electronic address identification scheme identifier
-         *
-         * @name `@schemeID`
-         */
-        schemeId: z.optional(icdCodesSchema()),
-      }),
-    })
-  ),
-  /**
-   * @example
-   *   Seller Business Name AS
-   *
-   * @summary PARTY NAME
-   *
-   * @name cac:PartyName
-   */
-  partyName: z.optional(
-    z.object({
-      /**
-       * @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: z.string(),
-    })
-  ),
-  /**
-   * @name cac:PostalAddress
-   */
-  postalAddress: addressSchema,
-  /**
-   * @remarks
-   *   Max 1 for a buyer, max 2 for a seller.
-   *
-   * @name cac:PartyTaxScheme
-   *
-   * @cardinality (0..2)
-   */
-  partyTaxSchemes: z.optional(z.array(partyTaxSchemeSchema).check(z.maxLength(2))),
-  /**
-   * @name cac:PartyLegalEntity
-   */
-  partyLegalEntity: partyLegalEntitySchema,
-  /**
-   * @name cac:Contact
-   */
-  contact: z.optional(contactSchema),
-});
-export type PeppolPartySchema = z.infer<typeof partyBaseSchema>;

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

@@ -1,29 +0,0 @@
-import * as z from 'zod/mini';
-
-import { identifierSchema } from '#/schemas/fields/identifier-schema';
-
-export const partyLegalEntitySchema = z.object({
-  /**
-   * @example
-   *   987654321;
-   *
-   * @name cbc:CompanyID (+ @schemeID)
-   */
-  companyId: z.optional(identifierSchema()),
-  /**
-   * @example
-   *   Share capital
-   *
-   * @name cbc:CompanyLegalForm
-   */
-  companyLegalForm: z.optional(z.string()),
-  /**
-   * @example
-   *   Full Formal Seller Name LTD.
-   *
-   * @name cbc:RegistrationName
-   */
-  registrationName: z.string(),
-});
-
-export type PeppolPartyLegalEntitySchema = z.infer<typeof partyLegalEntitySchema>;

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

@@ -1,33 +0,0 @@
-import * as z from 'zod/mini';
-
-/**
- * @name cac:PartyTaxScheme (0..2)
- */
-export const partyTaxSchemeSchema = z.object({
-  /**
-   * @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: z.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: z.object({
-    /**
-     * @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: z._default(z.string(), 'VAT'),
-  }),
-});
-
-export type PeppolPartyTaxSchema = z.infer<typeof partyTaxSchemeSchema>;

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

@@ -1,107 +0,0 @@
-import * as z from 'zod/mini';
-
-import { identifierSchema } from '#/schemas/fields/identifier-schema';
-import { icdCodesSchema } from '#/schemas/values/icd-codes';
-
-/**
- * @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 payeePartySchema = z.object({
-  /**
-   * @summary PARTY IDENTIFICATION
-   *
-   * @name `cac:PartyIdentification`
-   */
-  partyIdentification: z.optional(
-    z.object({
-      /**
-       * @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: z.optional(
-        z.extend(identifierSchema(), {
-          /**
-           * @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: z.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: z.optional(z.string()),
-        })
-      ),
-    })
-  ),
-  /**
-   * @summary PARTY LEGAL ENTITY
-   *
-   * @name `cac:PartyLegalEntity`
-   */
-  partyLegalEntity: z.optional(
-    z.object({
-      /**
-       * @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: z.optional(
-        z.safeExtend(identifierSchema(), {
-          /**
-           * @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: z.string(),
-          /**
-           * @description The identification scheme identifier of the Payee legal registration identifier.
-           *
-           * @summary Payee legal registration identifier identification scheme identifier
-           *
-           * @name `@schemeID`
-           */
-          schemeId: z.optional(icdCodesSchema()),
-        })
-      ),
-    })
-  ),
-  /**
-   * @description The name of the payee.
-   *
-   * @example
-   *   `Payee Name Ltd`;
-   *
-   * @summary Payee name
-   *
-   * @name `cac:PartyName`
-   */
-  partyName: z.object({ name: z.string() }),
-});
-export type PeppolPayeeParty = z.infer<typeof payeePartySchema>;

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

@@ -1,209 +0,0 @@
-import * as z from 'zod/mini';
-
-import { paymentMeansCodeSchema } from '#/schemas/values/payment-means-codes-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 paymentMeansSchema = z.object({
-  /**
-   * @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: z.object({
-    /**
-     * @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: z.optional(z.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: z.optional(z.iso.date()),
-  /**
-   * @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: z.optional(z.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: z.optional(
-    z.object({
-      /**
-       * @description The name of the payment card holder.
-       *
-       * @summary Payment card holder name
-       *
-       * @name cbc:HolderName
-       */
-      holderName: z.optional(z.string()),
-      /**
-       * @summary Syntax required element not related to a business term.
-       *
-       * @name cbc:NetworkID
-       */
-      networkId: z.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: z.string(),
-    })
-  ),
-  /**
-   * @description A group of business terms to specify credit transfer payments.
-   *
-   * @summary CREDIT TRANSFER
-   *
-   * @name cac:PayeeFinancialAccount
-   */
-  payeeFinancialAccount: z.optional(
-    z.object({
-      /**
-       * @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: z.optional(
-        z.object({
-          /**
-           * @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: z.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: z.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: z.optional(z.string()),
-    })
-  ),
-  /**
-   * @description A group of business terms to specify a direct debit.
-   *
-   * @summary DIRECT DEBIT
-   *
-   * @name cac:PaymentMandate
-   */
-  paymentMandate: z.optional(
-    z.object({
-      /**
-       * @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: z.optional(z.string()),
-      /**
-       * @description The account to be debited by the direct debit.
-       *
-       * @example
-       *   `12345676543`;
-       *
-       * @summary Debited account identifier
-       *
-       * @name `cac:PayerFinancialAccount`
-       */
-      payerFinancialAccountId: z.optional(
-        z.object({
-          /**
-           * @description The account to be debited by the direct debit.
-           *
-           * @example
-           *   `12345676543`;
-           *
-           * @summary Debited account identifier
-           *
-           * @name `cbc:ID`
-           */
-          id: z.string(),
-        })
-      ),
-    })
-  ),
-});
-
-export type PeppolPaymentMeans = z.infer<typeof paymentMeansSchema>;

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

@@ -1,23 +0,0 @@
-import * as z from 'zod/mini';
-
-/**
- * @summary PAYMENT TERMS
- *
- * @name cac:PaymentTerms
- */
-export const paymentTermsSchema = z.object({
-  /**
-   * @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: z.string(),
-});
-
-export type PeppolPaymentTerms = z.infer<typeof paymentTermsSchema>;

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

@@ -1,31 +0,0 @@
-import * as z from 'zod/mini';
-
-import { amountSchema } from '#/schemas/fields/amount-schema';
-import { linePriceAllowanceChargeSchema } from '#/schemas/fields/line-price-allowance-charge-schema';
-import { quantitySchema } from '#/schemas/fields/quantity-schema';
-
-/**
- * @summary Price details on invoice line
- *
- * @name cac:Price
- */
-export const linePriceSchema = z.object({
-  /**
-   * @name cac:AllowanceCharge
-   *
-   * @cardinality 0..1
-   */
-  allowanceCharge: z.optional(linePriceAllowanceChargeSchema),
-  /**
-   * @name cbc:BaseQuantity (+ @unitCode)
-   *
-   * @cardinality 0..1
-   */
-  baseQuantity: z.optional(quantitySchema),
-  /**
-   * @name cbc:PriceAmount (+ @currencyID)
-   */
-  priceAmount: amountSchema,
-});
-
-export type PeppolLinePrice = z.infer<typeof linePriceSchema>;

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

@@ -1,21 +0,0 @@
-import * as z from 'zod/mini';
-
-import { quantityUnitCodesSchema } from '#/schemas/values/quantity-unit-codes-schema';
-
-/**
- * @summary Quantity with optional unit code
- *
- * @name `cbc:* (+ @unitCode)`
- */
-export const quantitySchema = z.object({
-  /**
-   * @name `@unitCode`
-   */
-  unitCode: z.optional(quantityUnitCodesSchema()),
-  /**
-   * @name `#text (value)`
-   */
-  value: z.number(),
-});
-
-export type PeppolQuantity = z.infer<typeof quantitySchema>;

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

@@ -1,4 +0,0 @@
-import * as z from 'zod/mini';
-
-export const referenceSchema = z.optional(z.object({ id: z.string() }));
-export type PeppolReferenceSchema = z.infer<typeof referenceSchema>;

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

@@ -1,41 +0,0 @@
-import * as z from 'zod/mini';
-
-import { dutyTaxFeeCategorySchema } from '#/schemas/values/duty-tax-fee-cateogries';
-
-/**
- * @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 taxCategorySchema = z.object({
-  /**
-   * @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: z.optional(z.number()),
-  /**
-   * @default VAT
-   *
-   * @name `cac:TaxScheme`
-   */
-  taxSchemeId: z.object({
-    /**
-     * @name `cbc:ID`
-     */
-    id: z._default(z.string(), 'VAT'),
-  }),
-});
-
-export type PeppolTaxCategory = z.infer<typeof taxCategorySchema>;

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

@@ -1,23 +0,0 @@
-import * as z from 'zod/mini';
-
-import { addressSchema } from '#/schemas/fields/address-schema';
-import { partyTaxSchemeSchema } from '#/schemas/fields/party-tax-schema';
-
-/**
- * @summary SELLER TAX REPRESENTATIVE PARTY
- *
- * @name cac:TaxRepresentativeParty
- */
-export const taxRepresentativeSchema = z.object({
-  /**
-   * @name cac:PartyName/cbc:Name
-   */
-  name: z.string(),
-  /**
-   * @name cac:PostalAddress
-   */
-  postalAddress: addressSchema,
-  partyTaxScheme: partyTaxSchemeSchema,
-});
-
-export type PeppolTaxRepresentativeParty = z.infer<typeof taxRepresentativeSchema>;

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

@@ -1,26 +0,0 @@
-import * as z from 'zod/mini';
-
-import { taxCategorySchema } from '#/schemas/fields/tax-category-schema';
-
-/**
- * @description This one is specific for TaxSubtotal since it includes more fields.
- *
- * @summary Tax Category for Tax Subtotal
- *
- * @name cac:TaxCategory
- */
-export const taxSubtotalCategorySchema = z.extend(taxCategorySchema, {
-  /**
-   * @description The reason for the tax exemption.
-   *
-   * @name cbc:TaxExemptionReason
-   */
-  taxExemptionReason: z.optional(z.string()),
-  /**
-   * @description The code for the reason of the tax exemption.
-   *
-   * @name cbc:TaxExemptionReasonCode
-   */
-  taxExemptionReasonCode: z.optional(z.string()),
-});
-export type PeppolTaxSubTotalCategory = z.infer<typeof taxSubtotalCategorySchema>;