@endevops/peppol-schema 0.0.1 → 0.1.0-beta.1

package/dist/effect/fields/party-base-schema.js

@@ -0,0 +1,127 @@
+import { identifierSchema } from "./identifier-schema.js";
+import { icdCodesSchema } from "../values/icd-codes.js";
+import { addressSchema } from "./address-schema.js";
+import { electronicCodesSchema } from "../values/eas-codes.js";
+import { contactSchema } from "./contact-schema.js";
+import { partyLegalEntitySchema } from "./party-legal-entity-schema.js";
+import { partyTaxSchemeSchema } from "./party-tax-schema.js";
+import { Schema } from "effect";
+//#region src/effect/fields/party-base-schema.ts
+/**
+* @summary Party common substructure
+*
+* @name cac:Party
+*/
+const partyBaseSchema = 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: identifierSchema().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()
+	})),
+	/**
+	* @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: identifierSchema().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: addressSchema,
+	/**
+	* @remarks
+	*   Max 1 for a buyer, max 2 for a seller.
+	*
+	* @name cac:PartyTaxScheme
+	*
+	* @cardinality (0..2)
+	*/
+	partyTaxSchemes: Schema.optional(Schema.Array(partyTaxSchemeSchema).check(Schema.isMaxLength(2))),
+	/**
+	* @name cac:PartyLegalEntity
+	*/
+	partyLegalEntity: partyLegalEntitySchema,
+	/**
+	* @name cac:Contact
+	*/
+	contact: Schema.optional(contactSchema)
+});
+//#endregion
+export { partyBaseSchema };
+
+//# sourceMappingURL=party-base-schema.js.map

package/dist/effect/fields/party-base-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"party-base-schema.js","names":[],"sources":["../../../src/effect/fields/party-base-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { electronicCodesSchema } from '#/effect/values/eas-codes';\nimport { icdCodesSchema } from '#/effect/values/icd-codes';\n\nimport { addressSchema } from './address-schema';\nimport { contactSchema } from './contact-schema';\nimport { identifierSchema } from './identifier-schema';\nimport { partyLegalEntitySchema } from './party-legal-entity-schema';\nimport { partyTaxSchemeSchema } from './party-tax-schema';\n\n/**\n * @summary Party common substructure\n *\n * @name cac:Party\n */\nexport const partyBaseSchema = Schema.Struct({\n  /**\n   * @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.\n   *\n   * @example\n   *   7300010000001;\n   *\n   * @summary Seller/Buyer electronic address\n   *\n   * @name `cbc:EndpointID`\n   */\n  endpointId: identifierSchema().pipe(\n    Schema.fieldsAssign({\n      /**\n       * @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.\n       *\n       * @example\n       *   7300010000001;\n       *\n       * @summary Seller/Buyer electronic address\n       *\n       * @name `#text`\n       */\n      id: Schema.String,\n      /**\n       * @description The identification scheme identifier of the Seller/Buyer electronic address.\n       *\n       * @summary Seller/Buyer electronic address identification scheme identifier\n       *\n       * @name `@schemeID`\n       */\n      schemeId: electronicCodesSchema(),\n    })\n  ),\n  /**\n   * @example\n   *   5060012349998;\n   *\n   * @summary PARTY IDENTIFICATION\n   *\n   * @name `cac:PartyIdentification`\n   */\n  partyIdentification: Schema.optional(\n    Schema.Struct({\n      /**\n       * @description An identifier of the Buyer/seller.\n       *\n       * @summary Buyer/seller identifier\n       *\n       * @name `cbc:ID`\n       */\n      id: identifierSchema().pipe(\n        Schema.fieldsAssign({\n          /**\n           * @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.\n           *\n           * @example\n           *   7300010000001;\n           *\n           * @summary Seller/Buyer electronic address\n           *\n           * @name `#text`\n           */\n          id: Schema.String,\n          /**\n           * @description The identification scheme identifier of the Seller/Buyer electronic address.\n           *\n           * @summary Seller/Buyer electronic address identification scheme identifier\n           *\n           * @name `@schemeID`\n           */\n          schemeId: Schema.optional(icdCodesSchema()),\n        })\n      ),\n    })\n  ),\n  /**\n   * @example\n   *   Seller Business Name AS\n   *\n   * @summary PARTY NAME\n   *\n   * @name cac:PartyName\n   */\n  partyName: Schema.optional(\n    Schema.Struct({\n      /**\n       * @description A name by which the Buyer/Seller is known, other than Buyer/Seller name (also known as Business name).\n       *\n       * @example\n       *   `Trading Name`;\n       *\n       * @summary Buyer/Seller trading name\n       */\n      name: Schema.String,\n    })\n  ),\n  /**\n   * @name cac:PostalAddress\n   */\n  postalAddress: addressSchema,\n  /**\n   * @remarks\n   *   Max 1 for a buyer, max 2 for a seller.\n   *\n   * @name cac:PartyTaxScheme\n   *\n   * @cardinality (0..2)\n   */\n  partyTaxSchemes: Schema.optional(Schema.Array(partyTaxSchemeSchema).check(Schema.isMaxLength(2))),\n  /**\n   * @name cac:PartyLegalEntity\n   */\n  partyLegalEntity: partyLegalEntitySchema,\n  /**\n   * @name cac:Contact\n   */\n  contact: Schema.optional(contactSchema),\n});\n\nexport type PeppolPartySchema = typeof partyBaseSchema.Type;\n"],"mappings":";;;;;;;;;;;;;;AAgBA,MAAa,kBAAkB,OAAO,OAAO;;;;;;;;;;;CAW3C,YAAY,iBAAiB,CAAC,CAAC,KAC7B,OAAO,aAAa;;;;;;;;;;;EAWlB,IAAI,OAAO;;;;;;;;EAQX,UAAU,sBAAsB;CAClC,CAAC,CACH;;;;;;;;;CASA,qBAAqB,OAAO,SAC1B,OAAO,OAAO;;;;;;;;AAQZ,IAAI,iBAAiB,CAAC,CAAC,KACrB,OAAO,aAAa;;;;;;;;;;;EAWlB,IAAI,OAAO;;;;;;;;EAQX,UAAU,OAAO,SAAS,eAAe,CAAC;CAC5C,CAAC,CACH,EACF,CAAC,CACH;;;;;;;;;CASA,WAAW,OAAO,SAChB,OAAO,OAAO;;;;;;;;;AASZ,MAAM,OAAO,OACf,CAAC,CACH;;;;CAIA,eAAe;;;;;;;;;CASf,iBAAiB,OAAO,SAAS,OAAO,MAAM,oBAAoB,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC,CAAC;;;;CAIhG,kBAAkB;;;;CAIlB,SAAS,OAAO,SAAS,aAAa;AACxC,CAAC"}

package/dist/effect/fields/party-legal-entity-schema.d.ts

@@ -0,0 +1,31 @@
+import { Schema } from "effect";
+//#region src/effect/fields/party-legal-entity-schema.d.ts
+export declare const partyLegalEntitySchema: Schema.Struct<{
+  /**
+   * @example
+   *   987654321;
+   *
+   * @name cbc:CompanyID (+ @schemeID)
+   */
+  readonly companyId: Schema.optional<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly schemeId: Schema.optional<Schema.String>;
+  }>>;
+  /**
+   * @example
+   *   Share capital
+   *
+   * @name cbc:CompanyLegalForm
+   */
+  readonly companyLegalForm: Schema.optional<Schema.String>;
+  /**
+   * @example
+   *   Full Formal Seller Name LTD.
+   *
+   * @name cbc:RegistrationName
+   */
+  readonly registrationName: Schema.String;
+}>;
+export type PeppolPartyLegalEntitySchema = typeof partyLegalEntitySchema.Type;
+//#endregion
+//# sourceMappingURL=party-legal-entity-schema.d.ts.map

package/dist/effect/fields/party-legal-entity-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"party-legal-entity-schema.d.ts","names":[],"sources":["../../../src/effect/fields/party-legal-entity-schema.ts"],"mappings":";;qBAIa,wBAAsB,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;YAwBvB,sCAAsC,uBAAuB"}

package/dist/effect/fields/party-legal-entity-schema.js

@@ -0,0 +1,30 @@
+import { identifierSchema } from "./identifier-schema.js";
+import { Schema } from "effect";
+//#region src/effect/fields/party-legal-entity-schema.ts
+const partyLegalEntitySchema = Schema.Struct({
+	/**
+	* @example
+	*   987654321;
+	*
+	* @name cbc:CompanyID (+ @schemeID)
+	*/
+	companyId: Schema.optional(identifierSchema()),
+	/**
+	* @example
+	*   Share capital
+	*
+	* @name cbc:CompanyLegalForm
+	*/
+	companyLegalForm: Schema.optional(Schema.String),
+	/**
+	* @example
+	*   Full Formal Seller Name LTD.
+	*
+	* @name cbc:RegistrationName
+	*/
+	registrationName: Schema.String
+});
+//#endregion
+export { partyLegalEntitySchema };
+
+//# sourceMappingURL=party-legal-entity-schema.js.map

package/dist/effect/fields/party-legal-entity-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"party-legal-entity-schema.js","names":[],"sources":["../../../src/effect/fields/party-legal-entity-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { identifierSchema } from './identifier-schema';\n\nexport const partyLegalEntitySchema = Schema.Struct({\n  /**\n   * @example\n   *   987654321;\n   *\n   * @name cbc:CompanyID (+ @schemeID)\n   */\n  companyId: Schema.optional(identifierSchema()),\n  /**\n   * @example\n   *   Share capital\n   *\n   * @name cbc:CompanyLegalForm\n   */\n  companyLegalForm: Schema.optional(Schema.String),\n  /**\n   * @example\n   *   Full Formal Seller Name LTD.\n   *\n   * @name cbc:RegistrationName\n   */\n  registrationName: Schema.String,\n});\n\nexport type PeppolPartyLegalEntitySchema = typeof partyLegalEntitySchema.Type;\n"],"mappings":";;;AAIA,MAAa,yBAAyB,OAAO,OAAO;;;;;;;CAOlD,WAAW,OAAO,SAAS,iBAAiB,CAAC;;;;;;;CAO7C,kBAAkB,OAAO,SAAS,OAAO,MAAM;;;;;;;CAO/C,kBAAkB,OAAO;AAC3B,CAAC"}

package/dist/effect/fields/party-tax-schema.d.ts

@@ -0,0 +1,34 @@
+import { Schema } from "effect";
+//#region src/effect/fields/party-tax-schema.d.ts
+/**
+ * @name cac:PartyTaxScheme (0..2)
+ */
+export declare const partyTaxSchemeSchema: 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`
+   */
+  readonly 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`
+   */
+  readonly 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
+     */
+    readonly id: Schema.withDecodingDefaultType<Schema.String, never>;
+  }>;
+}>;
+export type PeppolPartyTaxSchema = typeof partyTaxSchemeSchema.Type;
+//#endregion
+//# sourceMappingURL=party-tax-schema.d.ts.map

package/dist/effect/fields/party-tax-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"party-tax-schema.d.ts","names":[],"sources":["../../../src/effect/fields/party-tax-schema.ts"],"mappings":";;;;;qBAKa,sBAAoB,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;YA2BrB,8BAA8B,qBAAqB"}

package/dist/effect/fields/party-tax-schema.js

@@ -0,0 +1,34 @@
+import { Effect, Schema } from "effect";
+//#region src/effect/fields/party-tax-schema.ts
+/**
+* @name cac:PartyTaxScheme (0..2)
+*/
+const partyTaxSchemeSchema = 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"))) })
+});
+//#endregion
+export { partyTaxSchemeSchema };
+
+//# sourceMappingURL=party-tax-schema.js.map

package/dist/effect/fields/party-tax-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"party-tax-schema.js","names":[],"sources":["../../../src/effect/fields/party-tax-schema.ts"],"sourcesContent":["import { Effect, Schema } from 'effect';\n\n/**\n * @name cac:PartyTaxScheme (0..2)\n */\nexport const partyTaxSchemeSchema = Schema.Struct({\n  /**\n   * @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\n   * Seller for tax purposes or a reference that enables the Seller to state his registered tax status. In order for the buyer to automatically\n   * identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31)\n   * shall be present.\n   *\n   * @summary Seller VAT identifier, Seller tax registration identifier\n   *\n   * @name `cbc:CompanyID`\n   */\n  companyId: Schema.String,\n  /**\n   * @description Mandatory element. For Seller VAT identifier (BT-31), use value “VAT”, for the seller tax registration identifier (BT-32), use != \"VAT\"\n   *\n   * @name `cac:TaxScheme`\n   */\n  taxSchemeId: Schema.Struct({\n    /**\n     * @description Mandatory element. For Seller VAT identifier (BT-31), use value “VAT”, for the seller tax registration identifier (BT-32), use != \"VAT\"\n     *\n     * @name cbc:ID\n     */\n    id: Schema.String.pipe(Schema.withDecodingDefaultType(Effect.succeed('VAT'))),\n  }),\n});\n\nexport type PeppolPartyTaxSchema = typeof partyTaxSchemeSchema.Type;\n"],"mappings":";;;;;AAKA,MAAa,uBAAuB,OAAO,OAAO;;;;;;;;;;;CAWhD,WAAW,OAAO;;;;;;CAMlB,aAAa,OAAO,OAAO;;;;;;AAMzB,IAAI,OAAO,OAAO,KAAK,OAAO,wBAAwB,OAAO,QAAQ,KAAK,CAAC,CAAC,EAC9E,CAAC;AACH,CAAC"}

package/dist/effect/fields/payee-party.d.ts

@@ -0,0 +1,68 @@
+import { Schema } from "effect";
+//#region src/effect/fields/payee-party.d.ts
+/**
+ * @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 declare const payeePartySchema: Schema.Struct<{
+  /**
+   * @summary PARTY IDENTIFICATION
+   *
+   * @name `cac:PartyIdentification`
+   */
+  readonly 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`
+     */
+    readonly id: Schema.optional<Schema.Struct<{
+      readonly id: Schema.String;
+      readonly schemeId: Schema.optional<Schema.String>;
+    }>>;
+  }>>;
+  /**
+   * @summary PARTY LEGAL ENTITY
+   *
+   * @name `cac:PartyLegalEntity`
+   */
+  readonly 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`
+     */
+    readonly companyId: Schema.optional<Schema.Struct<{
+      readonly id: Schema.String;
+      readonly schemeId: Schema.optional<Schema.Literals<[string, ...string[]]>>;
+    }>>;
+  }>>;
+  /**
+   * @description The name of the payee.
+   *
+   * @example
+   *   `Payee Name Ltd`;
+   *
+   * @summary Payee name
+   *
+   * @name `cac:PartyName`
+   */
+  readonly partyName: Schema.Struct<{
+    readonly name: Schema.String;
+  }>;
+}>;
+export type PeppolPayeeParty = typeof payeePartySchema.Type;
+//#endregion
+//# sourceMappingURL=payee-party.d.ts.map

package/dist/effect/fields/payee-party.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payee-party.d.ts","names":[],"sources":["../../../src/effect/fields/payee-party.ts"],"mappings":";;;;;;;;;;qBAca,kBAAgB,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAkGjB,0BAA0B,iBAAiB"}

package/dist/effect/fields/payee-party.js

@@ -0,0 +1,99 @@
+import { identifierSchema } from "./identifier-schema.js";
+import { icdCodesSchema } from "../values/icd-codes.js";
+import { Schema } from "effect";
+//#region src/effect/fields/payee-party.ts
+/**
+* @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
+*/
+const payeePartySchema = 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(identifierSchema().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(identifierSchema().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 })
+});
+//#endregion
+export { payeePartySchema };
+
+//# sourceMappingURL=payee-party.js.map

package/dist/effect/fields/payee-party.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payee-party.js","names":[],"sources":["../../../src/effect/fields/payee-party.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { icdCodesSchema } from '#/effect/values/icd-codes';\n\nimport { identifierSchema } from './identifier-schema';\n\n/**\n * @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\n * different from the seller.\n *\n * @summary PAYEE\n *\n * @name cac:PayeeParty\n */\nexport const payeePartySchema = Schema.Struct({\n  /**\n   * @summary PARTY IDENTIFICATION\n   *\n   * @name `cac:PartyIdentification`\n   */\n  partyIdentification: Schema.optional(\n    Schema.Struct({\n      /**\n       * @description This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee\n       * bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.\n       *\n       * @summary Payee identifier or bank assigned crditor identifier\n       *\n       * @name `cbc:ID`\n       */\n      id: Schema.optional(\n        identifierSchema().pipe(\n          Schema.fieldsAssign({\n            /**\n             * @description This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the\n             * Payee bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.\n             *\n             * @summary Payee identifier or bank assigned crditor identifier\n             *\n             * @name `#text`\n             */\n            id: Schema.String,\n            /**\n             * @description The identification scheme identifier of the payee identifier. For bank assigned creditor identifier (BT-90), value MUST be \"SEPA\"\n             *\n             * @summary Payee or bank assigned creditor identifier identification scheme identifier\n             *\n             * @name `@schemeID`\n             */\n            schemeId: Schema.optional(Schema.String),\n          })\n        )\n      ),\n    })\n  ),\n  /**\n   * @summary PARTY LEGAL ENTITY\n   *\n   * @name `cac:PartyLegalEntity`\n   */\n  partyLegalEntity: Schema.optional(\n    Schema.Struct({\n      /**\n       * @description An identifier issued by an official registrar that identifies the payee as a legal entity or person.\n       *\n       * @example\n       *   `FR932874294`;\n       *\n       * @summary Payee legal registration identifier\n       *\n       * @name `cbc:CompanyID`\n       */\n      companyId: Schema.optional(\n        identifierSchema().pipe(\n          Schema.fieldsAssign({\n            /**\n             * @description An identifier issued by an official registrar that identifies the payee as a legal entity or person.\n             *\n             * @example\n             *   `FR932874294`;\n             *\n             * @summary Payee legal registration identifier\n             *\n             * @name `#text`\n             */\n            id: Schema.String,\n            /**\n             * @description The identification scheme identifier of the Payee legal registration identifier.\n             *\n             * @summary Payee legal registration identifier identification scheme identifier\n             *\n             * @name `@schemeID`\n             */\n            schemeId: Schema.optional(icdCodesSchema()),\n          })\n        )\n      ),\n    })\n  ),\n  /**\n   * @description The name of the payee.\n   *\n   * @example\n   *   `Payee Name Ltd`;\n   *\n   * @summary Payee name\n   *\n   * @name `cac:PartyName`\n   */\n  partyName: Schema.Struct({ name: Schema.String }),\n});\n\nexport type PeppolPayeeParty = typeof payeePartySchema.Type;\n"],"mappings":";;;;;;;;;;;;AAcA,MAAa,mBAAmB,OAAO,OAAO;;;;;;CAM5C,qBAAqB,OAAO,SAC1B,OAAO,OAAO;;;;;;;;;AASZ,IAAI,OAAO,SACT,iBAAiB,CAAC,CAAC,KACjB,OAAO,aAAa;;;;;;;;;EASlB,IAAI,OAAO;;;;;;;;EAQX,UAAU,OAAO,SAAS,OAAO,MAAM;CACzC,CAAC,CACH,CACF,EACF,CAAC,CACH;;;;;;CAMA,kBAAkB,OAAO,SACvB,OAAO,OAAO;;;;;;;;;;;AAWZ,WAAW,OAAO,SAChB,iBAAiB,CAAC,CAAC,KACjB,OAAO,aAAa;;;;;;;;;;;EAWlB,IAAI,OAAO;;;;;;;;EAQX,UAAU,OAAO,SAAS,eAAe,CAAC;CAC5C,CAAC,CACH,CACF,EACF,CAAC,CACH;;;;;;;;;;;CAWA,WAAW,OAAO,OAAO,EAAE,MAAM,OAAO,OAAO,CAAC;AAClD,CAAC"}

package/dist/effect/fields/payment-means-schema.d.ts

@@ -0,0 +1,198 @@
+import { Schema } from "effect";
+//#region src/effect/fields/payment-means-schema.d.ts
+/**
+ * @description A group of business terms providing information about the payment.
+ *
+ * @summary Payment means (credit transfer/direct debit/card)
+ *
+ * @name cac:PaymentMeans
+ */
+export declare const paymentMeansSchema: 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`
+   */
+  readonly 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`
+     */
+    readonly code: Schema.Literals<[string, ...string[]]>;
+    /**
+     * @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`
+     */
+    readonly 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`
+   */
+  readonly paymentDueDate: Schema.optional<Schema.String>;
+  /**
+   * @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
+   */
+  readonly 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
+   */
+  readonly cardAccount: Schema.optional<Schema.Struct<{
+    /**
+     * @description The name of the payment card holder.
+     *
+     * @summary Payment card holder name
+     *
+     * @name cbc:HolderName
+     */
+    readonly holderName: Schema.optional<Schema.String>;
+    /**
+     * @summary Syntax required element not related to a business term.
+     *
+     * @name cbc:NetworkID
+     */
+    readonly 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
+     */
+    readonly primaryAccountNumberId: Schema.String;
+  }>>;
+  /**
+   * @description A group of business terms to specify credit transfer payments.
+   *
+   * @summary CREDIT TRANSFER
+   *
+   * @name cac:PayeeFinancialAccount
+   */
+  readonly 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`
+     */
+    readonly 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`
+       */
+      readonly 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
+     */
+    readonly 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
+     */
+    readonly name: Schema.optional<Schema.String>;
+  }>>;
+  /**
+   * @description A group of business terms to specify a direct debit.
+   *
+   * @summary DIRECT DEBIT
+   *
+   * @name cac:PaymentMandate
+   */
+  readonly 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
+     */
+    readonly id: Schema.optional<Schema.String>;
+    /**
+     * @description The account to be debited by the direct debit.
+     *
+     * @example
+     *   `12345676543`;
+     *
+     * @summary Debited account identifier
+     *
+     * @name `cac:PayerFinancialAccount`
+     */
+    readonly payerFinancialAccountId: Schema.optional<Schema.Struct<{
+      /**
+       * @description The account to be debited by the direct debit.
+       *
+       * @example
+       *   `12345676543`;
+       *
+       * @summary Debited account identifier
+       *
+       * @name `cbc:ID`
+       */
+      readonly id: Schema.String;
+    }>>;
+  }>>;
+}>;
+export type PeppolPaymentMeans = typeof paymentMeansSchema.Type;
+//#endregion
+//# sourceMappingURL=payment-means-schema.d.ts.map

package/dist/effect/fields/payment-means-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payment-means-schema.d.ts","names":[],"sources":["../../../src/effect/fields/payment-means-schema.ts"],"mappings":";;;;;;;;;qBAYa,oBAAkB,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAqMnB,4BAA4B,mBAAmB"}