@endevops/peppol-schema 0.1.0-beta.3 → 0.1.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -6
- package/dist/constants.d.ts +51 -0
- package/dist/constants.d.ts.map +1 -0
- package/dist/constants.js +48 -0
- package/dist/constants.js.map +1 -0
- package/dist/eas-codes.generated-D8jjHFij.js.map +1 -1
- package/dist/index-CfjMSrpQ.d.ts +3508 -0
- package/dist/index-CfjMSrpQ.d.ts.map +1 -0
- package/dist/index.d.ts +2 -2613
- package/dist/index.js +3121 -1563
- package/dist/index.js.map +1 -1
- package/dist/invoice-response-code-not-needs-schema-p_RKKNLc.js +18 -0
- package/dist/invoice-response-code-not-needs-schema-p_RKKNLc.js.map +1 -0
- package/dist/invoice-response-codes.d.ts +11 -0
- package/dist/invoice-response-codes.d.ts.map +1 -0
- package/dist/invoice-response-codes.js +32 -0
- package/dist/invoice-response-codes.js.map +1 -0
- package/dist/invoice-status-codes.generated-DL-agLdx.d.ts +24 -0
- package/dist/invoice-status-codes.generated-DL-agLdx.d.ts.map +1 -0
- package/dist/message-level-response-profile-id-DBpOW91B.js +9 -0
- package/dist/message-level-response-profile-id-DBpOW91B.js.map +1 -0
- package/dist/peppol-iso-date-string-BXLxzxdz.js +30 -0
- package/dist/peppol-iso-date-string-BXLxzxdz.js.map +1 -0
- package/dist/schematron.d.ts +408 -365
- package/dist/schematron.d.ts.map +1 -1
- package/dist/schematron.js +1975 -1501
- package/dist/schematron.js.map +1 -1
- package/dist/values.d.ts +95 -13218
- package/dist/values.d.ts.map +1 -1
- package/dist/values.js +1 -1
- package/dist/vat-dates.generated-CxFvt7m3.d.ts +68 -0
- package/dist/vat-dates.generated-CxFvt7m3.d.ts.map +1 -0
- package/dist/{vatex-codes.generated-BSgP3n5t.js → vatex-codes.generated-N7wsUrLh.js} +8 -9
- package/dist/vatex-codes.generated-N7wsUrLh.js.map +1 -0
- package/package.json +16 -18
- package/src/constants/transport-profile.ts +5 -1
- package/src/decoders/decode-billing.ts +1 -1
- package/src/decoders/decode-credit-note.ts +2 -4
- package/src/decoders/decode-invoice-response.ts +15 -37
- package/src/decoders/decode-invoice.ts +2 -4
- package/src/decoders/decode-message-level-response.ts +21 -48
- package/src/decoders/encode-credit-note.ts +1 -1
- package/src/decoders/encode-invoice-response.ts +7 -4
- package/src/decoders/encode-invoice.ts +1 -1
- package/src/decoders/encode-message-level-response.ts +4 -10
- package/src/decoders/fields/decode-additional-document-references.ts +1 -1
- package/src/decoders/fields/decode-address.ts +1 -1
- package/src/decoders/fields/decode-allowance-charges.ts +7 -15
- package/src/decoders/fields/decode-amount.ts +2 -2
- package/src/decoders/fields/decode-application-response.ts +21 -0
- package/src/decoders/fields/decode-billing-references.ts +1 -1
- package/src/decoders/fields/decode-contact.ts +1 -1
- package/src/decoders/fields/decode-credit-note-lines.ts +7 -15
- package/src/decoders/fields/decode-delivery.ts +1 -1
- package/src/decoders/fields/decode-electronic-address.ts +1 -1
- package/src/decoders/fields/decode-identifier.ts +1 -1
- package/src/decoders/fields/decode-invoice-line-period.ts +1 -1
- package/src/decoders/fields/decode-invoice-lines.ts +6 -14
- package/src/decoders/fields/decode-invoice-message-document-party.ts +2 -2
- package/src/decoders/fields/decode-invoice-message-party.ts +1 -6
- package/src/decoders/fields/decode-invoice-period.ts +7 -13
- package/src/decoders/fields/decode-legal-monetary-total.ts +1 -1
- package/src/decoders/fields/decode-line-allowance-charges.ts +7 -14
- package/src/decoders/fields/decode-line-price.ts +1 -7
- package/src/decoders/fields/decode-line-shared.ts +2 -4
- package/src/decoders/fields/decode-message-level-party.ts +1 -1
- package/src/decoders/fields/decode-node-list.ts +15 -0
- package/src/decoders/fields/decode-order-reference.ts +1 -1
- package/src/decoders/fields/decode-parties-tax-scheme.ts +1 -1
- package/src/decoders/fields/decode-party-legal-entity.ts +1 -1
- package/src/decoders/fields/decode-party-tax-scheme.ts +1 -1
- package/src/decoders/fields/decode-party.ts +3 -14
- package/src/decoders/fields/decode-payee-party.ts +1 -1
- package/src/decoders/fields/decode-payment-means.ts +2 -2
- package/src/decoders/fields/decode-payment-terms.ts +1 -1
- package/src/decoders/fields/decode-price-allowance-charge.ts +1 -7
- package/src/decoders/fields/decode-quantity.ts +1 -6
- package/src/decoders/fields/decode-simple-identifier.ts +1 -1
- package/src/decoders/fields/decode-tax-category.ts +1 -1
- package/src/decoders/fields/decode-tax-representative-party.ts +1 -1
- package/src/decoders/fields/decode-tax-totals.ts +2 -2
- package/src/decoders/fields/encode-additional-document-references.ts +3 -2
- package/src/decoders/fields/encode-address.ts +1 -1
- package/src/decoders/fields/encode-allowance-charges.ts +3 -2
- package/src/decoders/fields/encode-amount.ts +1 -1
- package/src/decoders/fields/encode-billing-references.ts +2 -2
- package/src/decoders/fields/encode-contact.ts +1 -1
- package/src/decoders/fields/encode-credit-note-lines.ts +2 -2
- package/src/decoders/fields/encode-delivery.ts +1 -1
- package/src/decoders/fields/encode-identifier.ts +1 -1
- package/src/decoders/fields/encode-invoice-line-period.ts +1 -1
- package/src/decoders/fields/encode-invoice-lines.ts +2 -2
- package/src/decoders/fields/encode-invoice-period.ts +1 -1
- package/src/decoders/fields/encode-legal-monetary-total.ts +1 -1
- package/src/decoders/fields/encode-line-allowance-charges.ts +2 -2
- package/src/decoders/fields/encode-line-price.ts +1 -1
- package/src/decoders/fields/encode-line-shared.ts +1 -1
- package/src/decoders/fields/encode-message-party.ts +3 -3
- package/src/decoders/fields/encode-order-reference.ts +1 -1
- package/src/decoders/fields/encode-parties-tax-scheme.ts +1 -1
- package/src/decoders/fields/encode-party-tax-scheme.ts +1 -1
- package/src/decoders/fields/encode-party.ts +1 -1
- package/src/decoders/fields/encode-payee-party.ts +1 -1
- package/src/decoders/fields/encode-payment-means.ts +2 -2
- package/src/decoders/fields/encode-payment-terms.ts +1 -1
- package/src/decoders/fields/encode-price-allowance-charges.ts +1 -1
- package/src/decoders/fields/encode-quantity.ts +1 -1
- package/src/decoders/fields/encode-tax-category.ts +1 -1
- package/src/decoders/fields/encode-tax-representative-party.ts +1 -1
- package/src/decoders/fields/encode-tax-totals.ts +4 -4
- package/src/helpers/bool.ts +9 -12
- package/src/helpers/get-prop.ts +2 -4
- package/src/helpers/str-or-und.ts +3 -4
- package/src/helpers/str.ts +12 -8
- package/src/index.ts +56 -6
- package/src/schemas/fields/peppol-additional-document-reference-schema.ts +123 -0
- package/src/schemas/fields/peppol-address-schema.ts +112 -0
- package/src/schemas/fields/peppol-allowance-charge-schema.ts +104 -0
- package/src/schemas/fields/peppol-amount-schema.ts +23 -0
- package/src/schemas/fields/peppol-base-line-schema.ts +141 -0
- package/src/{effect → schemas}/fields/peppol-billing-reference-schema.ts +25 -20
- package/src/schemas/fields/peppol-binary-object-schema.ts +52 -0
- package/src/schemas/fields/peppol-contact-schema.ts +20 -0
- package/src/schemas/fields/peppol-credit-note-line-schema.ts +44 -0
- package/src/schemas/fields/peppol-delivery-schema.ts +109 -0
- package/src/schemas/fields/peppol-identifier-schema.ts +21 -0
- package/src/schemas/fields/peppol-invoice-line-period-schema.ts +35 -0
- package/src/{effect → schemas}/fields/peppol-invoice-line-schema.ts +10 -9
- package/src/schemas/fields/peppol-invoice-period-schema.ts +31 -0
- package/src/schemas/fields/peppol-item-classification-schema.ts +46 -0
- package/src/schemas/fields/peppol-legal-monetary-total-schema.ts +127 -0
- package/src/schemas/fields/peppol-line-allowance-charge-schema.ts +68 -0
- package/src/schemas/fields/peppol-line-item-schema.ts +196 -0
- package/src/schemas/fields/peppol-line-price-allowance-charge-schema.ts +41 -0
- package/src/schemas/fields/peppol-line-price-schema.ts +32 -0
- package/src/schemas/fields/peppol-order-reference-schema.ts +38 -0
- package/src/schemas/fields/peppol-party-base-schema.ts +145 -0
- package/src/schemas/fields/peppol-party-legal-entity-schema.ts +32 -0
- package/src/schemas/fields/peppol-party-tax-scheme-schema.ts +41 -0
- package/src/schemas/fields/peppol-payee-party-schema.ts +119 -0
- package/src/schemas/fields/peppol-payment-means-schema.ts +224 -0
- package/src/schemas/fields/peppol-payment-terms-schema.ts +25 -0
- package/src/schemas/fields/peppol-quantity-schema.ts +22 -0
- package/src/schemas/fields/peppol-reference-schema.ts +9 -0
- package/src/schemas/fields/peppol-tax-category-schema.ts +47 -0
- package/src/schemas/fields/peppol-tax-representative-schema.ts +26 -0
- package/src/{effect → schemas}/fields/peppol-tax-subtotal-category-schema.ts +7 -5
- package/src/schemas/fields/peppol-tax-subtotal-schema.ts +33 -0
- package/src/schemas/fields/peppol-tax-totals-base-schema.ts +28 -0
- package/src/schemas/peppol-billing-base-schema.ts +366 -0
- package/src/schemas/peppol-credit-note-schema.ts +31 -0
- package/src/schemas/peppol-document-response-document-reference-schema.ts +41 -0
- package/src/schemas/peppol-document-response-document-schema.ts +38 -0
- package/src/schemas/peppol-document-response-line-response-content-schema.ts +49 -0
- package/src/schemas/peppol-document-response-line-response-schema.ts +40 -0
- package/src/schemas/peppol-document-schema.ts +120 -0
- package/src/{effect → schemas}/peppol-invoice-response-document-actual-response-schema.ts +25 -16
- package/src/schemas/peppol-invoice-response-document-actual-response-status-schema.ts +63 -0
- package/src/schemas/peppol-invoice-response-schema.ts +176 -0
- package/src/schemas/peppol-invoice-response-status-reason-code-schema.ts +40 -0
- package/src/schemas/peppol-invoice-schema.ts +45 -0
- package/src/schemas/peppol-iso-date-string.ts +20 -0
- package/src/schemas/peppol-message-level-response-document-response-schema.ts +35 -0
- package/src/schemas/peppol-message-level-response-party-schema.ts +20 -0
- package/src/schemas/peppol-message-level-response-schema.ts +98 -0
- package/src/schemas/utils/format-xsd-time.ts +80 -0
- package/src/{effect → schemas}/utils/index.ts +1 -1
- package/src/schemas/utils/is-valid-process.ts +1 -1
- package/src/schemas/utils/opaque.ts +19 -0
- package/src/schemas/utils/peppol-xsd-time-schema.ts +79 -0
- package/src/schemas/utils/quantity-unit-code-to-intl-unit.ts +2 -2
- package/src/schemas/values/credit-note-type-code-schema.ts +3 -5
- package/src/{effect → schemas}/values/currency-code-schema.ts +7 -1
- package/src/schemas/values/document-type-schemes-schema.ts +3 -5
- package/src/schemas/values/document-type-values-schema.ts +4 -7
- package/src/{effect → schemas}/values/duty-tax-fee-category-schema.ts +3 -2
- package/src/schemas/values/invoice-type-code-schema.ts +4 -8
- package/src/schemas/values/process-from-document-type-schema.ts +10 -12
- package/src/schemas/values/quantity-unit-codes-schema.ts +4 -8
- package/src/schematron/cen/ae/cen-en16931-br-ae-01.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-02.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-03.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-04.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-05.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-06.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-07.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-08.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-09.ts +6 -5
- package/src/schematron/cen/ae/cen-en16931-br-ae-10.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-01.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-02.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-03.ts +6 -10
- package/src/schematron/cen/af/cen-en16931-br-af-04.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-05.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-06.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-07.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-08.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-09.ts +6 -5
- package/src/schematron/cen/af/cen-en16931-br-af-10.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-01.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-02.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-03.ts +6 -10
- package/src/schematron/cen/ag/cen-en16931-br-ag-04.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-05.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-06.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-07.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-08.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-09.ts +6 -5
- package/src/schematron/cen/ag/cen-en16931-br-ag-10.ts +6 -5
- package/src/schematron/cen/b/cen-en16931-br-b-01.ts +6 -5
- package/src/schematron/cen/b/cen-en16931-br-b-02.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-01.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-02.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-03.ts +9 -6
- package/src/schematron/cen/cen-en16931-br-04.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-05.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-06.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-07.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-08.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-09.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-10.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-11.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-12.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-13.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-14.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-15.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-16.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-17.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-18.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-19.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-20.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-21.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-22.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-23.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-24.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-25.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-26.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-27.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-28.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-29.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-30.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-31.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-32.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-33.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-36.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-37.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-38.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-41.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-42.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-43.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-44.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-45.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-46.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-47.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-48.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-49.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-50.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-51.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-52.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-53.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-54.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-55.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-56.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-57.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-61.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-62.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-63.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-64.ts +6 -5
- package/src/schematron/cen/cen-en16931-br-65.ts +6 -5
- package/src/schematron/cen/cl/cen-en16931-br-cl-08.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-03.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-04.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-05.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-06.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-07.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-08.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-09.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-10.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-11.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-12.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-13.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-14.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-15.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-16.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-17.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-18.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-19.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-20.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-21.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-22.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-23.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-24.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-25.ts +6 -5
- package/src/schematron/cen/co/cen-en16931-br-co-26.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-01.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-02.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-05.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-06.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-09.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-10.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-11.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-12.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-13.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-14.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-15.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-16.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-17.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-18.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-19.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-20.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-23.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-24.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-25.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-27.ts +6 -5
- package/src/schematron/cen/dec/cen-en16931-br-dec-28.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-01.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-02.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-03.ts +6 -10
- package/src/schematron/cen/e/cen-en16931-br-e-04.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-05.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-06.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-07.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-08.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-09.ts +6 -5
- package/src/schematron/cen/e/cen-en16931-br-e-10.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-01.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-02.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-03.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-04.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-05.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-06.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-07.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-08.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-09.ts +6 -5
- package/src/schematron/cen/g/cen-en16931-br-g-10.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-01.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-02.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-03.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-04.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-05.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-06.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-07.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-08.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-09.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-10.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-11.ts +6 -5
- package/src/schematron/cen/ic/cen-en16931-br-ic-12.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-01.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-02.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-03.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-04.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-05.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-06.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-07.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-08.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-09.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-10.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-11.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-12.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-13.ts +6 -5
- package/src/schematron/cen/o/cen-en16931-br-o-14.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-01.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-02.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-03.ts +6 -10
- package/src/schematron/cen/s/cen-en16931-br-s-04.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-05.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-06.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-07.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-08.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-09.ts +6 -5
- package/src/schematron/cen/s/cen-en16931-br-s-10.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-01.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-02.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-03.ts +6 -10
- package/src/schematron/cen/z/cen-en16931-br-z-04.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-05.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-06.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-07.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-08.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-09.ts +6 -5
- package/src/schematron/cen/z/cen-en16931-br-z-10.ts +6 -5
- package/src/schematron/de/de-r-001.ts +8 -7
- package/src/schematron/de/de-r-002.ts +8 -7
- package/src/schematron/de/de-r-003.ts +8 -7
- package/src/schematron/de/de-r-004.ts +8 -7
- package/src/schematron/de/de-r-005.ts +8 -7
- package/src/schematron/de/de-r-006.ts +8 -7
- package/src/schematron/de/de-r-007.ts +8 -7
- package/src/schematron/de/de-r-008.ts +8 -7
- package/src/schematron/de/de-r-009.ts +8 -7
- package/src/schematron/de/de-r-010.ts +9 -8
- package/src/schematron/de/de-r-011.ts +9 -8
- package/src/schematron/de/de-r-014.ts +8 -7
- package/src/schematron/de/de-r-015.ts +8 -7
- package/src/schematron/de/de-r-016.ts +9 -8
- package/src/schematron/de/de-r-017.ts +8 -7
- package/src/schematron/de/de-r-018.ts +10 -9
- package/src/schematron/de/de-r-019.ts +8 -7
- package/src/schematron/de/de-r-020.ts +8 -7
- package/src/schematron/de/de-r-022.ts +8 -7
- package/src/schematron/de/de-r-023-1.ts +8 -7
- package/src/schematron/de/de-r-023-2.ts +8 -7
- package/src/schematron/de/de-r-024-1.ts +8 -7
- package/src/schematron/de/de-r-024-2.ts +8 -7
- package/src/schematron/de/de-r-025-1.ts +8 -7
- package/src/schematron/de/de-r-025-2.ts +8 -7
- package/src/schematron/de/de-r-026.ts +9 -8
- package/src/schematron/de/de-r-027.ts +8 -7
- package/src/schematron/de/de-r-028.ts +8 -7
- package/src/schematron/de/de-r-030.ts +9 -8
- package/src/schematron/de/de-r-031.ts +8 -7
- package/src/schematron/dk/dk-r-002.ts +7 -6
- package/src/schematron/dk/dk-r-003.ts +8 -7
- package/src/schematron/dk/dk-r-004.ts +8 -7
- package/src/schematron/dk/dk-r-005.ts +8 -7
- package/src/schematron/dk/dk-r-006.ts +8 -7
- package/src/schematron/dk/dk-r-007.ts +8 -7
- package/src/schematron/dk/dk-r-008.ts +8 -7
- package/src/schematron/dk/dk-r-009.ts +8 -7
- package/src/schematron/dk/dk-r-010.ts +8 -7
- package/src/schematron/dk/dk-r-011.ts +8 -7
- package/src/schematron/dk/dk-r-013.ts +8 -7
- package/src/schematron/dk/dk-r-014.ts +7 -6
- package/src/schematron/dk/dk-r-016.ts +8 -7
- package/src/schematron/dk/dk-r-017.ts +8 -7
- package/src/schematron/errors.ts +17 -0
- package/src/schematron/gr/gr-r-001-1.ts +7 -6
- package/src/schematron/gr/gr-r-001-2.ts +8 -7
- package/src/schematron/gr/gr-r-001-3.ts +14 -9
- package/src/schematron/gr/gr-r-001-4.ts +8 -7
- package/src/schematron/gr/gr-r-001-5.ts +8 -7
- package/src/schematron/gr/gr-r-001-6.ts +7 -6
- package/src/schematron/gr/gr-r-001-7.ts +7 -6
- package/src/schematron/gr/gr-r-002.ts +7 -6
- package/src/schematron/gr/gr-r-003.ts +8 -7
- package/src/schematron/gr/gr-r-004-1.ts +7 -6
- package/src/schematron/gr/gr-r-004-2.ts +7 -6
- package/src/schematron/gr/gr-r-005.ts +7 -6
- package/src/schematron/gr/gr-r-006.ts +8 -7
- package/src/schematron/gr/gr-r-008-2.ts +7 -6
- package/src/schematron/gr/gr-r-008-3.ts +7 -6
- package/src/schematron/gr/gr-r-009.ts +7 -6
- package/src/schematron/gr/gr-r-010.ts +7 -6
- package/src/schematron/gr/gr-s-008-1.ts +7 -6
- package/src/schematron/gr/gr-s-011.ts +8 -7
- package/src/schematron/helpers.ts +36 -11
- package/src/schematron/index.ts +6 -1
- package/src/schematron/is/is-r-001.ts +7 -6
- package/src/schematron/is/is-r-002.ts +7 -6
- package/src/schematron/is/is-r-003.ts +7 -6
- package/src/schematron/is/is-r-004.ts +7 -6
- package/src/schematron/is/is-r-005.ts +7 -6
- package/src/schematron/is/is-r-006.ts +8 -7
- package/src/schematron/is/is-r-007.ts +8 -7
- package/src/schematron/is/is-r-008.ts +8 -7
- package/src/schematron/is/is-r-009.ts +8 -7
- package/src/schematron/is/is-r-010.ts +9 -8
- package/src/schematron/it/it-r-001.ts +7 -6
- package/src/schematron/it/it-r-002.ts +7 -6
- package/src/schematron/it/it-r-003.ts +7 -6
- package/src/schematron/it/it-r-004.ts +7 -6
- package/src/schematron/nl/nl-r-001.ts +7 -6
- package/src/schematron/nl/nl-r-002.ts +7 -6
- package/src/schematron/nl/nl-r-003.ts +8 -7
- package/src/schematron/nl/nl-r-004.ts +7 -6
- package/src/schematron/nl/nl-r-005.ts +8 -7
- package/src/schematron/nl/nl-r-006.ts +8 -7
- package/src/schematron/nl/nl-r-007.ts +8 -7
- package/src/schematron/nl/nl-r-008.ts +7 -6
- package/src/schematron/nl/nl-r-009.ts +8 -7
- package/src/schematron/no/no-r-001.ts +8 -7
- package/src/schematron/no/no-r-002.ts +7 -6
- package/src/schematron/peppol/cl/peppol-en16931-cl001.ts +6 -5
- package/src/schematron/peppol/cl/peppol-en16931-cl002.ts +6 -5
- package/src/schematron/peppol/cl/peppol-en16931-cl003.ts +6 -5
- package/src/schematron/peppol/cl/peppol-en16931-cl006.ts +7 -6
- package/src/schematron/peppol/cl/peppol-en16931-cl007.ts +6 -5
- package/src/schematron/peppol/cl/peppol-en16931-cl008.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r040.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r041.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r042.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r043.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r044.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r045.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r046.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r047.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r049.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r050.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r052.ts +6 -5
- package/src/schematron/peppol/common/peppol-common-r053.ts +6 -5
- package/src/schematron/peppol/f/peppol-en16931-f001.ts +20 -13
- package/src/schematron/peppol/p/peppol-en16931-p0100.ts +8 -7
- package/src/schematron/peppol/p/peppol-en16931-p0101.ts +8 -7
- package/src/schematron/peppol/p/peppol-en16931-p0104.ts +6 -5
- package/src/schematron/peppol/p/peppol-en16931-p0105.ts +6 -5
- package/src/schematron/peppol/p/peppol-en16931-p0106.ts +6 -5
- package/src/schematron/peppol/p/peppol-en16931-p0107.ts +6 -5
- package/src/schematron/peppol/p/peppol-en16931-p0108.ts +6 -5
- package/src/schematron/peppol/p/peppol-en16931-p0109.ts +6 -5
- package/src/schematron/peppol/p/peppol-en16931-p0110.ts +6 -5
- package/src/schematron/peppol/p/peppol-en16931-p0111.ts +6 -5
- package/src/schematron/peppol/p/peppol-en16931-p0112.ts +7 -6
- package/src/schematron/peppol/r/peppol-en16931-r001.ts +11 -13
- package/src/schematron/peppol/r/peppol-en16931-r002.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r003.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r004.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r005.ts +7 -6
- package/src/schematron/peppol/r/peppol-en16931-r007.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r008.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r010.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r020.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r040.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r041.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r042.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r043.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r044.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r046.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r051.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r053.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r054.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r055.ts +8 -7
- package/src/schematron/peppol/r/peppol-en16931-r061.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r100.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r101.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r110.ts +7 -6
- package/src/schematron/peppol/r/peppol-en16931-r111.ts +7 -6
- package/src/schematron/peppol/r/peppol-en16931-r120.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r121.ts +6 -5
- package/src/schematron/peppol/r/peppol-en16931-r130.ts +6 -5
- package/src/schematron/run-all-rules.ts +2 -7
- package/src/schematron/schematron.ts +36 -0
- package/src/schematron/se/se-r-001.ts +7 -6
- package/src/schematron/se/se-r-002.ts +7 -6
- package/src/schematron/se/se-r-003.ts +7 -6
- package/src/schematron/se/se-r-004.ts +7 -6
- package/src/schematron/se/se-r-005.ts +8 -7
- package/src/schematron/se/se-r-006.ts +7 -6
- package/src/schematron/se/se-r-007.ts +7 -6
- package/src/schematron/se/se-r-008.ts +7 -6
- package/src/schematron/se/se-r-009.ts +7 -6
- package/src/schematron/se/se-r-010.ts +7 -6
- package/src/schematron/se/se-r-011.ts +7 -6
- package/src/schematron/se/se-r-012.ts +7 -6
- package/src/schematron/se/se-r-013.ts +7 -6
- package/src/values/additional-document-reference-codes.generated.ts +2 -3
- package/src/values/allowance-charge-reason-codes.generated.ts +1 -1
- package/src/values/application-response-type-codes.generated.ts +1 -1
- package/src/values/charge-reason-codes.generated.ts +1 -1
- package/src/values/country-code.generated.ts +1 -1
- package/src/values/credit-notes-type-codes.generated.ts +1 -1
- package/src/values/currency-code.generated.ts +1 -1
- package/src/values/document-type-codes.generated.ts +1 -1
- package/src/values/document-type.generated.ts +2 -2
- package/src/values/duty-tax-fee-categories.generated.ts +1 -1
- package/src/values/eas-codes.generated.ts +1 -1
- package/src/values/icd-codes.generated.ts +7 -7
- package/src/values/invoice-status-codes.generated.ts +1 -1
- package/src/values/invoice-type-codes.generated.ts +1 -1
- package/src/values/item-classification-code.generated.ts +1 -1
- package/src/values/mime-codes.generated.ts +1 -1
- package/src/values/op-status-action.generated.ts +1 -1
- package/src/values/op-status-reason.generated.ts +1 -1
- package/src/values/participant-identifier-schemes.generated.ts +2 -2
- package/src/values/payment-means-codes.generated.ts +1 -1
- package/src/values/processes.generated.ts +1 -1
- package/src/values/quantity-unit-codes.generated.ts +1 -1
- package/src/values/vat-dates.generated.ts +1 -1
- package/src/values/vatex-codes.generated.ts +1 -1
- package/dist/all-union-fields-CxoyKBpI.d.ts +0 -445
- package/dist/all-union-fields-CxoyKBpI.d.ts.map +0 -1
- package/dist/document-DCcObB-a.d.ts +0 -1466
- package/dist/document-DCcObB-a.d.ts.map +0 -1
- package/dist/effect.d.ts +0 -6274
- package/dist/effect.d.ts.map +0 -1
- package/dist/effect.js +0 -3239
- package/dist/effect.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/is-valid-process-CSWL-q9f.js +0 -1590
- package/dist/is-valid-process-CSWL-q9f.js.map +0 -1
- package/dist/quantity-unit-code-to-intl-unit-15EykjMe.d.ts +0 -168
- package/dist/quantity-unit-code-to-intl-unit-15EykjMe.d.ts.map +0 -1
- package/dist/vat-dates.generated-DTVWQAdn.d.ts +0 -4812
- package/dist/vat-dates.generated-DTVWQAdn.d.ts.map +0 -1
- package/dist/vatex-codes.generated-BSgP3n5t.js.map +0 -1
- package/src/decoders/errors.ts +0 -11
- package/src/document-parser.ts +0 -70
- package/src/document.ts +0 -19
- package/src/effect/fields/default-customization-id.ts +0 -1
- package/src/effect/fields/default-profile-id.ts +0 -1
- package/src/effect/fields/peppol-additional-document-reference-schema.ts +0 -114
- package/src/effect/fields/peppol-address-schema.ts +0 -105
- package/src/effect/fields/peppol-allowance-charge-schema.ts +0 -94
- package/src/effect/fields/peppol-amount-schema.ts +0 -21
- package/src/effect/fields/peppol-base-line-schema.ts +0 -138
- package/src/effect/fields/peppol-binary-object-schema.ts +0 -51
- package/src/effect/fields/peppol-contact-schema.ts +0 -18
- package/src/effect/fields/peppol-credit-note-line-schema.ts +0 -41
- package/src/effect/fields/peppol-delivery-schema.ts +0 -100
- package/src/effect/fields/peppol-identifier-schema.ts +0 -19
- package/src/effect/fields/peppol-invoice-line-period-schema.ts +0 -34
- package/src/effect/fields/peppol-invoice-period-schema.ts +0 -30
- package/src/effect/fields/peppol-item-classification-schema.ts +0 -45
- package/src/effect/fields/peppol-legal-monetary-total-schema.ts +0 -126
- package/src/effect/fields/peppol-line-allowance-charge-schema.ts +0 -63
- package/src/effect/fields/peppol-line-item-schema.ts +0 -185
- package/src/effect/fields/peppol-line-price-allowance-charge-schema.ts +0 -38
- package/src/effect/fields/peppol-line-price-schema.ts +0 -31
- package/src/effect/fields/peppol-order-reference-schema.ts +0 -36
- package/src/effect/fields/peppol-party-base-schema.ts +0 -136
- package/src/effect/fields/peppol-party-legal-entity-schema.ts +0 -29
- package/src/effect/fields/peppol-party-tax-scheme-schema.ts +0 -33
- package/src/effect/fields/peppol-payee-party-schema.ts +0 -112
- package/src/effect/fields/peppol-payment-means-schema.ts +0 -210
- package/src/effect/fields/peppol-payment-terms-schema.ts +0 -23
- package/src/effect/fields/peppol-quantity-schema.ts +0 -21
- package/src/effect/fields/peppol-reference-schema.ts +0 -5
- package/src/effect/fields/peppol-tax-category-schema.ts +0 -42
- package/src/effect/fields/peppol-tax-representative-schema.ts +0 -23
- package/src/effect/fields/peppol-tax-subtotal-schema.ts +0 -32
- package/src/effect/fields/peppol-tax-totals-base-schema.ts +0 -25
- package/src/effect/index.ts +0 -56
- package/src/effect/peppol-billing-base-schema.ts +0 -355
- package/src/effect/peppol-credit-note-schema.ts +0 -30
- package/src/effect/peppol-document-response-document-reference-schema.ts +0 -38
- package/src/effect/peppol-document-response-document-schema.ts +0 -35
- package/src/effect/peppol-document-response-line-response-content-schema.ts +0 -44
- package/src/effect/peppol-document-response-line-response-schema.ts +0 -33
- package/src/effect/peppol-document-schema.ts +0 -142
- package/src/effect/peppol-invoice-response-document-actual-response-status-schema.ts +0 -60
- package/src/effect/peppol-invoice-response-schema.ts +0 -168
- package/src/effect/peppol-invoice-response-status-reason-code-schema.ts +0 -31
- package/src/effect/peppol-invoice-schema.ts +0 -42
- package/src/effect/peppol-iso-date-string-schema.ts +0 -19
- package/src/effect/peppol-message-level-response-document-response-schema.ts +0 -33
- package/src/effect/peppol-message-level-response-party-schema.ts +0 -19
- package/src/effect/peppol-message-level-response-schema.ts +0 -97
- package/src/effect/utils/format-quantity-with-unit.ts +0 -1
- package/src/effect/utils/get-credit-note-type-code-description.ts +0 -1
- package/src/effect/utils/get-invoice-type-code-description.ts +0 -1
- package/src/effect/utils/is-valid-credit-note-type-code.ts +0 -1
- package/src/effect/utils/is-valid-invoice-type-code.ts +0 -1
- package/src/effect/utils/is-valid-process.ts +0 -1
- package/src/effect/utils/peppol-xsd-time-schema.ts +0 -13
- package/src/effect/utils/quantity-unit-code-to-intl-unit.ts +0 -2
- package/src/effect/values/credit-note-type-code-schema.ts +0 -23
- package/src/effect/values/document-type-schemes-schema.ts +0 -14
- package/src/effect/values/document-type-values-schema.ts +0 -16
- package/src/effect/values/invoice-type-code-schema.ts +0 -21
- package/src/effect/values/process-from-document-type-schema.ts +0 -26
- package/src/effect/values/quantity-unit-codes-schema.ts +0 -24
- package/src/helpers/errors.ts +0 -6
- package/src/helpers/is-defined.ts +0 -3
- package/src/schemas/billing-base.ts +0 -362
- package/src/schemas/credit-note.ts +0 -28
- package/src/schemas/document-response-document-reference-schema.ts +0 -37
- package/src/schemas/document-response-document-schema.ts +0 -34
- package/src/schemas/document-response-line-response-content.ts +0 -43
- package/src/schemas/document-response-line-response-schema.ts +0 -33
- package/src/schemas/fields/additional-document-reference-schema.ts +0 -112
- package/src/schemas/fields/address-schema.ts +0 -105
- package/src/schemas/fields/allowance-charge-schema.ts +0 -86
- package/src/schemas/fields/amount-schema.ts +0 -21
- package/src/schemas/fields/base-line-schema.ts +0 -136
- package/src/schemas/fields/billing-references-schema.ts +0 -44
- package/src/schemas/fields/binary-object-schema.ts +0 -45
- package/src/schemas/fields/contact-schema.ts +0 -18
- package/src/schemas/fields/credit-note-line-schema.ts +0 -37
- package/src/schemas/fields/date-only-fn.ts +0 -6
- package/src/schemas/fields/date-only-parser.ts +0 -20
- package/src/schemas/fields/delivery-schema.ts +0 -95
- package/src/schemas/fields/identifier-schema.ts +0 -24
- package/src/schemas/fields/invoice-line-period-schema.ts +0 -31
- package/src/schemas/fields/invoice-line-schema.ts +0 -41
- package/src/schemas/fields/invoice-period-schema.ts +0 -27
- package/src/schemas/fields/legal-monetary-total-schema.ts +0 -125
- package/src/schemas/fields/line-allowance-charge-schema.ts +0 -59
- package/src/schemas/fields/line-item-schema.ts +0 -183
- package/src/schemas/fields/line-price-allowance-charge-schema.ts +0 -33
- package/src/schemas/fields/list-identifier-schema.ts +0 -43
- package/src/schemas/fields/order-reference-schema.ts +0 -36
- package/src/schemas/fields/party-base-schema.ts +0 -131
- package/src/schemas/fields/party-legal-entity-schema.ts +0 -29
- package/src/schemas/fields/party-tax-schema.ts +0 -33
- package/src/schemas/fields/payee-party.ts +0 -107
- package/src/schemas/fields/payment-means-schema.ts +0 -209
- package/src/schemas/fields/payment-terms-schema.ts +0 -23
- package/src/schemas/fields/price-schema.ts +0 -31
- package/src/schemas/fields/quantity-schema.ts +0 -21
- package/src/schemas/fields/reference-schema.ts +0 -4
- package/src/schemas/fields/tax-category-schema.ts +0 -41
- package/src/schemas/fields/tax-representative-party-schema.ts +0 -23
- package/src/schemas/fields/tax-subtotal-category-schema.ts +0 -26
- package/src/schemas/fields/tax-subtotal-schema.ts +0 -32
- package/src/schemas/fields/tax-totals.ts +0 -25
- package/src/schemas/fields/time-only.ts +0 -23
- package/src/schemas/invoice-response-document-actual-response-status.ts +0 -58
- package/src/schemas/invoice-response-document-actual-response.ts +0 -73
- package/src/schemas/invoice-response-schema.ts +0 -155
- package/src/schemas/invoice-response-status-reason-code.ts +0 -30
- package/src/schemas/invoice.ts +0 -43
- package/src/schemas/message-level-response-document-response-schema.ts +0 -33
- package/src/schemas/message-level-response-party-schema.ts +0 -18
- package/src/schemas/message-level-response-schema.ts +0 -96
- package/src/schemas/utils/base-64.ts +0 -34
- package/src/schemas/utils/vat-regex.ts +0 -51
- package/src/schemas/utils/xsd-time.ts +0 -9
- package/src/schemas/values/additional-document-reference-code.ts +0 -27
- package/src/schemas/values/allowance-charge-reason-code.ts +0 -29
- package/src/schemas/values/application-response-type-codes.ts +0 -25
- package/src/schemas/values/charge-reason-code.ts +0 -29
- package/src/schemas/values/country-code.ts +0 -36
- package/src/schemas/values/currency-codes.ts +0 -35
- package/src/schemas/values/document-type-codes.ts +0 -25
- package/src/schemas/values/document-type-schema.ts +0 -49
- package/src/schemas/values/duty-tax-fee-cateogries.ts +0 -28
- package/src/schemas/values/eas-codes.ts +0 -35
- package/src/schemas/values/icd-codes.ts +0 -28
- package/src/schemas/values/invoice-status-codes.ts +0 -25
- package/src/schemas/values/item-classification-code-schema.ts +0 -28
- package/src/schemas/values/mime-code.ts +0 -28
- package/src/schemas/values/op-status-action.ts +0 -25
- package/src/schemas/values/op-status-reason.ts +0 -25
- package/src/schemas/values/participant-identifier-code.ts +0 -25
- package/src/schemas/values/payment-means-codes-schema.ts +0 -36
- package/src/schemas/values/process-schema.ts +0 -41
- package/src/schemas/values/process-xml-identifier-schema.ts +0 -27
- package/src/schemas/values/vat-date-code.ts +0 -15
- package/src/schemas/values/vatex-code.ts +0 -28
- package/src/schemas.ts +0 -97
- /package/src/{effect → schemas}/utils/peppol-base-64-schema.ts +0 -0
- /package/src/{effect → schemas}/utils/peppol-vat-regex-schema.ts +0 -0
- /package/src/{effect → schemas}/values/additional-document-reference-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/allowance-charge-reason-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/application-response-type-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/charge-reason-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/electronic-codes-schema.ts +0 -0
- /package/src/{effect → schemas}/values/icd-codes-schema.ts +0 -0
- /package/src/{effect → schemas}/values/index.ts +0 -0
- /package/src/{effect → schemas}/values/invoice-status-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/item-classification-codes-schema.ts +0 -0
- /package/src/{effect → schemas}/values/mime-codes-schema.ts +0 -0
- /package/src/{effect → schemas}/values/op-status-action-schema.ts +0 -0
- /package/src/{effect → schemas}/values/op-status-reason-schema.ts +0 -0
- /package/src/{effect → schemas}/values/participant-identifier-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/payment-means-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/peppol-country-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/peppol-document-type-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/peppol-document-type-schema.ts +0 -0
- /package/src/{effect → schemas}/values/peppol-process-schema.ts +0 -0
- /package/src/{effect → schemas}/values/vat-date-code-schema.ts +0 -0
- /package/src/{effect → schemas}/values/vatex-code-schema.ts +0 -0
|
@@ -0,0 +1,3508 @@
|
|
|
1
|
+
import { i as ApplicationResponseTypeCodesKeys, s as CreditNoteTypeCodesKeys, t as VatDateCodesKeys } from "./vat-dates.generated-CxFvt7m3.js";
|
|
2
|
+
import { DateTime, Schema } from "effect";
|
|
3
|
+
//#region src/schemas/utils/opaque.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* @description Nominal type produced by {@link opaque}. Equivalent to the type returned by `Schema.Opaque<Self>()(schema)`. Declaring the intersection once behind
|
|
6
|
+
* a named type keeps declaration emit compact: the wrapped struct is referenced a single time instead of being expanded in both `Schema.Opaque` and
|
|
7
|
+
* `Omit`.
|
|
8
|
+
*/
|
|
9
|
+
type OpaqueSchema<Self, S extends Schema.Top> = Schema.Opaque<Self, S, {}> & Omit<S, keyof Schema.Top>;
|
|
10
|
+
//#endregion
|
|
11
|
+
//#region src/schemas/peppol-iso-date-string.d.ts
|
|
12
|
+
declare const PeppolIsoDateString_base: OpaqueSchema<PeppolIsoDateString, Schema.decodeTo<Schema.DateTimeUtc, Schema.String, never, never>>;
|
|
13
|
+
/**
|
|
14
|
+
* @description ISO 8601 calendar date string (`YYYY-MM-DD`). Effect port of `dateOnly` (`z.iso.date()`): keeps the value as a plain string and only validates the
|
|
15
|
+
* shape — no `Date` conversion.
|
|
16
|
+
*
|
|
17
|
+
* @format date
|
|
18
|
+
*
|
|
19
|
+
* @see PEPPOL-EN16931-F001: A date MUST be formatted YYYY-MM-DD.
|
|
20
|
+
*/
|
|
21
|
+
declare class PeppolIsoDateString extends PeppolIsoDateString_base {}
|
|
22
|
+
//#endregion
|
|
23
|
+
//#region src/schemas/fields/peppol-amount-schema.d.ts
|
|
24
|
+
declare const PeppolAmount_base: OpaqueSchema<PeppolAmount, Schema.Struct<{
|
|
25
|
+
/**
|
|
26
|
+
* @name \@currencyID
|
|
27
|
+
*/
|
|
28
|
+
readonly currencyId: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCurrencyCode">;
|
|
29
|
+
/**
|
|
30
|
+
* @name #text (value)
|
|
31
|
+
*/
|
|
32
|
+
readonly value: Schema.Finite;
|
|
33
|
+
}>>;
|
|
34
|
+
/**
|
|
35
|
+
* @summary Monetary amount with mandatory currency
|
|
36
|
+
*
|
|
37
|
+
* @name cbc:* (+ @currencyID)
|
|
38
|
+
*/
|
|
39
|
+
declare class PeppolAmount extends PeppolAmount_base {}
|
|
40
|
+
interface PeppolAmountEncoded extends Schema.Codec.Encoded<typeof PeppolAmount> {}
|
|
41
|
+
//#endregion
|
|
42
|
+
//#region src/schemas/fields/peppol-allowance-charge-schema.d.ts
|
|
43
|
+
declare const PeppolTaxCategoryTaxSchemeId_base: OpaqueSchema<PeppolTaxCategoryTaxSchemeId, Schema.Struct<{
|
|
44
|
+
/**
|
|
45
|
+
* @description Mandatory element. Use "VAT"
|
|
46
|
+
*
|
|
47
|
+
* @name `cbc:ID`
|
|
48
|
+
*/
|
|
49
|
+
readonly id: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
50
|
+
}>>;
|
|
51
|
+
declare class PeppolTaxCategoryTaxSchemeId extends PeppolTaxCategoryTaxSchemeId_base {}
|
|
52
|
+
declare const BaseAllowanceCharge_base: OpaqueSchema<BaseAllowanceCharge, Schema.Struct<{
|
|
53
|
+
readonly amount: typeof PeppolAmount;
|
|
54
|
+
readonly baseAmount: Schema.optional<typeof PeppolAmount>;
|
|
55
|
+
readonly chargeIndicator: Schema.Boolean;
|
|
56
|
+
readonly allowanceChargeReason: Schema.optional<Schema.String>;
|
|
57
|
+
readonly multiplierFactorNumeric: Schema.optional<Schema.Finite>;
|
|
58
|
+
/**
|
|
59
|
+
* @summary TAX CATEGORY
|
|
60
|
+
*
|
|
61
|
+
* @name cac:TaxCategory
|
|
62
|
+
*/
|
|
63
|
+
readonly taxCategory: Schema.optional<Schema.Struct<{
|
|
64
|
+
readonly id: Schema.brand<Schema.Literals<readonly ["AE", "E", "S", "Z", "G", "O", "K", "L", "M", "B"]>, "PeppolDutyTaxFeeCategoryCode">;
|
|
65
|
+
readonly percent: Schema.optional<Schema.Finite>;
|
|
66
|
+
readonly taxSchemeId: typeof PeppolTaxCategoryTaxSchemeId;
|
|
67
|
+
}>>;
|
|
68
|
+
}>>;
|
|
69
|
+
declare class BaseAllowanceCharge extends BaseAllowanceCharge_base {}
|
|
70
|
+
declare const PeppolAllowance_base: OpaqueSchema<PeppolAllowance, Schema.Struct<{
|
|
71
|
+
readonly amount: typeof PeppolAmount;
|
|
72
|
+
readonly baseAmount: Schema.optional<typeof PeppolAmount>;
|
|
73
|
+
readonly allowanceChargeReason: Schema.optional<Schema.String>;
|
|
74
|
+
readonly multiplierFactorNumeric: Schema.optional<Schema.Finite>;
|
|
75
|
+
/**
|
|
76
|
+
* @summary TAX CATEGORY
|
|
77
|
+
*
|
|
78
|
+
* @name cac:TaxCategory
|
|
79
|
+
*/
|
|
80
|
+
readonly taxCategory: Schema.optional<Schema.Struct<{
|
|
81
|
+
readonly id: Schema.brand<Schema.Literals<readonly ["AE", "E", "S", "Z", "G", "O", "K", "L", "M", "B"]>, "PeppolDutyTaxFeeCategoryCode">;
|
|
82
|
+
readonly percent: Schema.optional<Schema.Finite>;
|
|
83
|
+
readonly taxSchemeId: typeof PeppolTaxCategoryTaxSchemeId;
|
|
84
|
+
}>>;
|
|
85
|
+
/**
|
|
86
|
+
* @name cbc:AllowanceChargeReasonCode
|
|
87
|
+
*/
|
|
88
|
+
readonly allowanceChargeReasonCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolAllowanceChargeReasonCode">>;
|
|
89
|
+
/**
|
|
90
|
+
* @name cbc:ChargeIndicator
|
|
91
|
+
*
|
|
92
|
+
* @value `false`
|
|
93
|
+
*/
|
|
94
|
+
readonly chargeIndicator: Schema.Literal<false>;
|
|
95
|
+
}>>;
|
|
96
|
+
declare class PeppolAllowance extends PeppolAllowance_base {}
|
|
97
|
+
declare const PeppolCharge_base: OpaqueSchema<PeppolCharge, Schema.Struct<{
|
|
98
|
+
readonly amount: typeof PeppolAmount;
|
|
99
|
+
readonly baseAmount: Schema.optional<typeof PeppolAmount>;
|
|
100
|
+
readonly allowanceChargeReason: Schema.optional<Schema.String>;
|
|
101
|
+
readonly multiplierFactorNumeric: Schema.optional<Schema.Finite>;
|
|
102
|
+
/**
|
|
103
|
+
* @summary TAX CATEGORY
|
|
104
|
+
*
|
|
105
|
+
* @name cac:TaxCategory
|
|
106
|
+
*/
|
|
107
|
+
readonly taxCategory: Schema.optional<Schema.Struct<{
|
|
108
|
+
readonly id: Schema.brand<Schema.Literals<readonly ["AE", "E", "S", "Z", "G", "O", "K", "L", "M", "B"]>, "PeppolDutyTaxFeeCategoryCode">;
|
|
109
|
+
readonly percent: Schema.optional<Schema.Finite>;
|
|
110
|
+
readonly taxSchemeId: typeof PeppolTaxCategoryTaxSchemeId;
|
|
111
|
+
}>>;
|
|
112
|
+
/**
|
|
113
|
+
* @name cbc:AllowanceChargeReasonCode
|
|
114
|
+
*/
|
|
115
|
+
readonly allowanceChargeReasonCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolChargeReasonCode">>;
|
|
116
|
+
/**
|
|
117
|
+
* @name cbc:ChargeIndicator
|
|
118
|
+
*
|
|
119
|
+
* @value `true`
|
|
120
|
+
*/
|
|
121
|
+
readonly chargeIndicator: Schema.Literal<true>;
|
|
122
|
+
}>>;
|
|
123
|
+
declare class PeppolCharge extends PeppolCharge_base {}
|
|
124
|
+
/**
|
|
125
|
+
* @summary Allowance/Charge
|
|
126
|
+
*
|
|
127
|
+
* @name cac:AllowanceCharge
|
|
128
|
+
*/
|
|
129
|
+
declare const peppolAllowanceChargeSchema: Schema.Union<readonly [typeof PeppolAllowance, typeof PeppolCharge]>;
|
|
130
|
+
type PeppolAllowanceCharge = Schema.Schema.Type<typeof peppolAllowanceChargeSchema>;
|
|
131
|
+
type PeppolAllowanceChargeEncoded = Schema.Codec.Encoded<typeof peppolAllowanceChargeSchema>;
|
|
132
|
+
//#endregion
|
|
133
|
+
//#region src/schemas/fields/peppol-binary-object-schema.d.ts
|
|
134
|
+
declare const PeppolBinaryObject_base: OpaqueSchema<PeppolBinaryObject, Schema.Struct<{
|
|
135
|
+
/**
|
|
136
|
+
* @description An attached document embedded as binary object (Base64) or sent together with the invoice.
|
|
137
|
+
*
|
|
138
|
+
* @example
|
|
139
|
+
* aHR0cHM6Ly90ZXN0LXZlZmEuZGlmaS5uby9wZXBwb2xiaXMvcG9hY2MvYmlsbGluZy8zLjAvYmlzLw==
|
|
140
|
+
*
|
|
141
|
+
* @summary Attached document
|
|
142
|
+
*
|
|
143
|
+
* @name `#text` (Base64 content)
|
|
144
|
+
*/
|
|
145
|
+
readonly content: Schema.Union<readonly [Schema.String, Schema.String]>;
|
|
146
|
+
/**
|
|
147
|
+
* @description The mime code of the attached document.
|
|
148
|
+
*
|
|
149
|
+
* @example
|
|
150
|
+
* text / csv;
|
|
151
|
+
*
|
|
152
|
+
* @summary Attached document Mime code
|
|
153
|
+
*
|
|
154
|
+
* @name `@mimeCode`
|
|
155
|
+
*/
|
|
156
|
+
readonly mimeCode: Schema.brand<Schema.Literals<readonly ["text/csv", "application/pdf", "image/png", "image/jpeg", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.oasis.opendocument.spreadsheet"]>, "PeppolMimeCode">;
|
|
157
|
+
/**
|
|
158
|
+
* @description The file name of the attached document.
|
|
159
|
+
*
|
|
160
|
+
* @example
|
|
161
|
+
* Hours - spent.csv;
|
|
162
|
+
*
|
|
163
|
+
* @summary Attached document Filename
|
|
164
|
+
*
|
|
165
|
+
* @name `@filename`
|
|
166
|
+
*/
|
|
167
|
+
readonly filename: Schema.String;
|
|
168
|
+
}>>;
|
|
169
|
+
/**
|
|
170
|
+
* @summary Binary object for attachments
|
|
171
|
+
*
|
|
172
|
+
* @name cbc:EmbeddedDocumentBinaryObject (+ @mimeCode, @filename)
|
|
173
|
+
*/
|
|
174
|
+
declare class PeppolBinaryObject extends PeppolBinaryObject_base {}
|
|
175
|
+
//#endregion
|
|
176
|
+
//#region src/schemas/fields/peppol-additional-document-reference-schema.d.ts
|
|
177
|
+
declare const PeppolAttachmentExternalReference_base: OpaqueSchema<PeppolAttachmentExternalReference, Schema.Struct<{
|
|
178
|
+
/**
|
|
179
|
+
* @description The URL (Uniform Resource Locator) that identifies where the external document is located. A means of locating the resource, including its
|
|
180
|
+
* primary access mechanism, e.g. http:// or ftp://.
|
|
181
|
+
*
|
|
182
|
+
* @example
|
|
183
|
+
* `http://www.example.com/index.html`;
|
|
184
|
+
*
|
|
185
|
+
* @summary External document location
|
|
186
|
+
*
|
|
187
|
+
* @name `cbc:URI`
|
|
188
|
+
*/
|
|
189
|
+
readonly uri: Schema.String;
|
|
190
|
+
}>>;
|
|
191
|
+
declare class PeppolAttachmentExternalReference extends PeppolAttachmentExternalReference_base {}
|
|
192
|
+
declare const PeppolAttachment_base: OpaqueSchema<PeppolAttachment, Schema.Struct<{
|
|
193
|
+
/**
|
|
194
|
+
* @description An attached document embedded as binary object (Base64) or sent together with the invoice.
|
|
195
|
+
*
|
|
196
|
+
* @example
|
|
197
|
+
* ```base64
|
|
198
|
+
* aHR0cHM6Ly90ZXN0LXZlZmEuZGlmaS5uby9wZXBwb2xiaXMvcG9hY2MvYmlsbGluZy8zLjAvYmlzLw==
|
|
199
|
+
* ```;
|
|
200
|
+
*
|
|
201
|
+
* @summary Attached document
|
|
202
|
+
*
|
|
203
|
+
* @name `cbc:EmbeddedDocumentBinaryObject`
|
|
204
|
+
*/
|
|
205
|
+
readonly embeddedDocumentBinaryObject: Schema.optional<typeof PeppolBinaryObject>;
|
|
206
|
+
/**
|
|
207
|
+
* @summary EXTERNAL REFERENCE
|
|
208
|
+
*
|
|
209
|
+
* @name `cac:ExternalReference`
|
|
210
|
+
*/
|
|
211
|
+
readonly externalReference: Schema.optional<typeof PeppolAttachmentExternalReference>;
|
|
212
|
+
}>>;
|
|
213
|
+
declare class PeppolAttachment extends PeppolAttachment_base {}
|
|
214
|
+
declare const PeppolId_base: OpaqueSchema<PeppolId, Schema.Struct<{
|
|
215
|
+
/**
|
|
216
|
+
* @description An identifier for an object on which the invoice is based (with DocumentTypeCode=130), given by the Seller, the identifier for the supporting
|
|
217
|
+
* document or the project reference identifier (DocumentTypeCode=50).
|
|
218
|
+
*
|
|
219
|
+
* @summary Invoiced object identifier, Supporting document reference or project reference
|
|
220
|
+
*
|
|
221
|
+
* @name `#text`
|
|
222
|
+
*/
|
|
223
|
+
readonly id: Schema.String;
|
|
224
|
+
/**
|
|
225
|
+
* @description The identification scheme identifier of the Invoiced object identifier.
|
|
226
|
+
*
|
|
227
|
+
* @summary Scheme identifier
|
|
228
|
+
*
|
|
229
|
+
* @name `@schemeID`
|
|
230
|
+
*/
|
|
231
|
+
readonly schemeId: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolAdditionalDocumentReferenceCode">>;
|
|
232
|
+
}>>;
|
|
233
|
+
declare class PeppolId extends PeppolId_base {}
|
|
234
|
+
declare const PeppolAdditionalDocumentReference_base: OpaqueSchema<PeppolAdditionalDocumentReference, Schema.Struct<{
|
|
235
|
+
readonly schemeId: Schema.optional<Schema.String>;
|
|
236
|
+
readonly id: typeof PeppolId;
|
|
237
|
+
readonly documentTypeCode: Schema.optional<Schema.String>;
|
|
238
|
+
readonly documentDescription: Schema.optional<Schema.String>;
|
|
239
|
+
readonly attachment: Schema.optional<typeof PeppolAttachment>;
|
|
240
|
+
}>>;
|
|
241
|
+
/**
|
|
242
|
+
* @description A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. The additional
|
|
243
|
+
* supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external document
|
|
244
|
+
* (referenced by a URL) or as an embedded document, Base64 encoded (such as a time report).
|
|
245
|
+
*
|
|
246
|
+
* @summary ADDITIONAL SUPPORTING DOCUMENTS
|
|
247
|
+
*
|
|
248
|
+
* @name `cac:AdditionalDocumentReference`
|
|
249
|
+
*/
|
|
250
|
+
declare class PeppolAdditionalDocumentReference extends PeppolAdditionalDocumentReference_base {}
|
|
251
|
+
//#endregion
|
|
252
|
+
//#region src/schemas/fields/peppol-billing-reference-schema.d.ts
|
|
253
|
+
declare const PeppolInvoiceDocumentReference_base: OpaqueSchema<PeppolInvoiceDocumentReference, Schema.Struct<{
|
|
254
|
+
/**
|
|
255
|
+
* @description The identification of an Invoice that was previously sent by the seller.
|
|
256
|
+
*
|
|
257
|
+
* @example
|
|
258
|
+
* `inv123`;
|
|
259
|
+
*
|
|
260
|
+
* @summary Preceding invoice number
|
|
261
|
+
*
|
|
262
|
+
* @name `cbc:ID`
|
|
263
|
+
*/
|
|
264
|
+
readonly id: Schema.String;
|
|
265
|
+
/**
|
|
266
|
+
* @description The date when the preceding invoice was issued. Shall be provided in case the preceding invoice identifier is not unique.
|
|
267
|
+
*
|
|
268
|
+
* @example
|
|
269
|
+
* `2017-09-15`;
|
|
270
|
+
*
|
|
271
|
+
* @summary Preceding invoice issue date
|
|
272
|
+
*
|
|
273
|
+
* @format `YYYY-MM-DD`
|
|
274
|
+
*
|
|
275
|
+
* @name `cbc:IssueDate`
|
|
276
|
+
*/
|
|
277
|
+
readonly issueDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
278
|
+
}>>;
|
|
279
|
+
declare class PeppolInvoiceDocumentReference extends PeppolInvoiceDocumentReference_base {}
|
|
280
|
+
declare const PeppolBillingReference_base: OpaqueSchema<PeppolBillingReference, Schema.Struct<{
|
|
281
|
+
/**
|
|
282
|
+
* @example
|
|
283
|
+
* inv123;
|
|
284
|
+
*
|
|
285
|
+
* @summary INVOICE DOCUMENT REFERENCE
|
|
286
|
+
*
|
|
287
|
+
* @name `cac:InvoiceDocumentReference`
|
|
288
|
+
*/
|
|
289
|
+
readonly invoiceDocumentReference: typeof PeppolInvoiceDocumentReference;
|
|
290
|
+
}>>;
|
|
291
|
+
/**
|
|
292
|
+
* @summary PRECEDING INVOICE REFERENCE (0..n)
|
|
293
|
+
*
|
|
294
|
+
* @name cac:BillingReference
|
|
295
|
+
*/
|
|
296
|
+
declare class PeppolBillingReference extends PeppolBillingReference_base {}
|
|
297
|
+
//#endregion
|
|
298
|
+
//#region src/schemas/fields/peppol-address-schema.d.ts
|
|
299
|
+
declare const PeppolAddressLine_base: OpaqueSchema<PeppolAddressLine, Schema.Struct<{
|
|
300
|
+
/**
|
|
301
|
+
* @description An additional address line in an address that can be used to give further details supplementing the main line.
|
|
302
|
+
*
|
|
303
|
+
* @summary Address line 3
|
|
304
|
+
*
|
|
305
|
+
* @name `cbc:Line`
|
|
306
|
+
*/
|
|
307
|
+
readonly line: Schema.String;
|
|
308
|
+
}>>;
|
|
309
|
+
declare class PeppolAddressLine extends PeppolAddressLine_base {}
|
|
310
|
+
declare const PeppolCountryCode_base: OpaqueSchema<PeppolCountryCode$1, Schema.Struct<{
|
|
311
|
+
/**
|
|
312
|
+
* @description A code that identifies the country.
|
|
313
|
+
*
|
|
314
|
+
* @example
|
|
315
|
+
* GB;
|
|
316
|
+
*
|
|
317
|
+
* @summary Country code
|
|
318
|
+
*
|
|
319
|
+
* @name `cbc:IdentificationCode`
|
|
320
|
+
*/
|
|
321
|
+
readonly identificationCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCountryCode">;
|
|
322
|
+
}>>;
|
|
323
|
+
declare class PeppolCountryCode$1 extends PeppolCountryCode_base {}
|
|
324
|
+
declare const PeppolAddress_base: OpaqueSchema<PeppolAddress, Schema.Struct<{
|
|
325
|
+
/**
|
|
326
|
+
* @description The main address line in an address.
|
|
327
|
+
*
|
|
328
|
+
* @example
|
|
329
|
+
* Main Street 1
|
|
330
|
+
*
|
|
331
|
+
* @summary Address line 1
|
|
332
|
+
*
|
|
333
|
+
* @name `cbc:StreetName`
|
|
334
|
+
*/
|
|
335
|
+
readonly streetName: Schema.optional<Schema.String>;
|
|
336
|
+
/**
|
|
337
|
+
* @description An additional address line in an address that can be used to give further details supplementing the main line.
|
|
338
|
+
*
|
|
339
|
+
* @example
|
|
340
|
+
* Po Box 351
|
|
341
|
+
*
|
|
342
|
+
* @summary Address line 2
|
|
343
|
+
*
|
|
344
|
+
* @name `cbc:AdditionalStreetName`
|
|
345
|
+
*/
|
|
346
|
+
readonly additionalStreetName: Schema.optional<Schema.String>;
|
|
347
|
+
/**
|
|
348
|
+
* @description The common name of the city, town or village, where the address is located.
|
|
349
|
+
*
|
|
350
|
+
* @example
|
|
351
|
+
* London;
|
|
352
|
+
*
|
|
353
|
+
* @summary Seller city
|
|
354
|
+
*
|
|
355
|
+
* @name `cbc:CityName`
|
|
356
|
+
*/
|
|
357
|
+
readonly cityName: Schema.optional<Schema.String>;
|
|
358
|
+
/**
|
|
359
|
+
* @description The identifier for an addressable group of properties according to the relevant postal service.
|
|
360
|
+
*
|
|
361
|
+
* @example
|
|
362
|
+
* W1G 8LZ
|
|
363
|
+
*
|
|
364
|
+
* @summary post code
|
|
365
|
+
*
|
|
366
|
+
* @name `cbc:PostalZone`
|
|
367
|
+
*/
|
|
368
|
+
readonly postalZone: Schema.optional<Schema.String>;
|
|
369
|
+
/**
|
|
370
|
+
* @description The subdivision of a country.
|
|
371
|
+
*
|
|
372
|
+
* @example
|
|
373
|
+
* Region A
|
|
374
|
+
*
|
|
375
|
+
* @summary Seller country subdivision
|
|
376
|
+
*
|
|
377
|
+
* @name `cbc:CountrySubentity`
|
|
378
|
+
*/
|
|
379
|
+
readonly countrySubentity: Schema.optional<Schema.String>;
|
|
380
|
+
/**
|
|
381
|
+
* @example
|
|
382
|
+
* GB;
|
|
383
|
+
*
|
|
384
|
+
* @name `cac:Country`
|
|
385
|
+
*/
|
|
386
|
+
readonly countryCode: typeof PeppolCountryCode$1;
|
|
387
|
+
/**
|
|
388
|
+
* @example
|
|
389
|
+
* Building 23
|
|
390
|
+
*
|
|
391
|
+
* @name `cac:AddressLine`
|
|
392
|
+
*/
|
|
393
|
+
readonly addressLine: Schema.optional<typeof PeppolAddressLine>;
|
|
394
|
+
}>>;
|
|
395
|
+
/**
|
|
396
|
+
* @summary Postal address
|
|
397
|
+
*
|
|
398
|
+
* @name `cac:PostalAddress`
|
|
399
|
+
*/
|
|
400
|
+
declare class PeppolAddress extends PeppolAddress_base {}
|
|
401
|
+
//#endregion
|
|
402
|
+
//#region src/schemas/fields/peppol-delivery-schema.d.ts
|
|
403
|
+
declare const PeppolDeliveryPartyPartyName_base: OpaqueSchema<PeppolDeliveryPartyPartyName, Schema.Struct<{
|
|
404
|
+
/**
|
|
405
|
+
* @description The name of the party to which the goods and services are delivered.
|
|
406
|
+
*
|
|
407
|
+
* @summary Deliver to party name
|
|
408
|
+
*
|
|
409
|
+
* @name `cbc:Name`
|
|
410
|
+
*/
|
|
411
|
+
readonly name: Schema.String;
|
|
412
|
+
}>>;
|
|
413
|
+
declare class PeppolDeliveryPartyPartyName extends PeppolDeliveryPartyPartyName_base {}
|
|
414
|
+
declare const PeppolDeliveryParty_base: OpaqueSchema<PeppolDeliveryParty, Schema.Struct<{
|
|
415
|
+
/**
|
|
416
|
+
* @summary PARTY NAME
|
|
417
|
+
*
|
|
418
|
+
* @name `cac:PartyName`
|
|
419
|
+
*/
|
|
420
|
+
readonly partyName: typeof PeppolDeliveryPartyPartyName;
|
|
421
|
+
}>>;
|
|
422
|
+
declare class PeppolDeliveryParty extends PeppolDeliveryParty_base {}
|
|
423
|
+
declare const PeppolDeliveryLocation_base: OpaqueSchema<PeppolDeliveryLocation, Schema.Struct<{
|
|
424
|
+
/**
|
|
425
|
+
* @description An identifier for the location at which the goods and services are delivered.
|
|
426
|
+
*
|
|
427
|
+
* @example
|
|
428
|
+
* `83745498753497`;
|
|
429
|
+
*
|
|
430
|
+
* @summary Deliver to location identifier
|
|
431
|
+
*
|
|
432
|
+
* @name `cbc:ID`
|
|
433
|
+
*/
|
|
434
|
+
readonly id: Schema.optional<Schema.Struct<{
|
|
435
|
+
readonly id: Schema.String;
|
|
436
|
+
readonly schemeId: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolIcdCode">>;
|
|
437
|
+
}>>;
|
|
438
|
+
/**
|
|
439
|
+
* @description A groupd of business terms providing infomation about the address to which goods and services invoiced were or are delivered.
|
|
440
|
+
*
|
|
441
|
+
* @summary Deliver to address
|
|
442
|
+
*
|
|
443
|
+
* @name `cac:Address`
|
|
444
|
+
*/
|
|
445
|
+
readonly address: Schema.optional<typeof PeppolAddress>;
|
|
446
|
+
}>>;
|
|
447
|
+
declare class PeppolDeliveryLocation extends PeppolDeliveryLocation_base {}
|
|
448
|
+
declare const PeppolDelivery_base: OpaqueSchema<PeppolDelivery, Schema.Struct<{
|
|
449
|
+
/**
|
|
450
|
+
* @description Th edate on which the supply of goods or services was made or completed.
|
|
451
|
+
*
|
|
452
|
+
* @example
|
|
453
|
+
* 2017 - 12 - 01;
|
|
454
|
+
*
|
|
455
|
+
* @summary Actual delivery date
|
|
456
|
+
*
|
|
457
|
+
* @format `YYYY-MM-DD`
|
|
458
|
+
*
|
|
459
|
+
* @name cbc:ActualDeliveryDate
|
|
460
|
+
*/
|
|
461
|
+
readonly actualDeliveryDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
462
|
+
/**
|
|
463
|
+
* @name `cac:DeliveryLocation`
|
|
464
|
+
*/
|
|
465
|
+
readonly deliveryLocation: Schema.optional<typeof PeppolDeliveryLocation>;
|
|
466
|
+
/**
|
|
467
|
+
* @summary Delivery party
|
|
468
|
+
*
|
|
469
|
+
* @name `cac:DeliveryParty`
|
|
470
|
+
*/
|
|
471
|
+
readonly deliveryParty: Schema.optional<typeof PeppolDeliveryParty>;
|
|
472
|
+
}>>;
|
|
473
|
+
declare class PeppolDelivery extends PeppolDelivery_base {}
|
|
474
|
+
//#endregion
|
|
475
|
+
//#region src/schemas/fields/peppol-invoice-period-schema.d.ts
|
|
476
|
+
declare const PeppolInvoicePeriod_base: OpaqueSchema<PeppolInvoicePeriod, Schema.Struct<{
|
|
477
|
+
readonly endDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
478
|
+
readonly startDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
479
|
+
readonly descriptionCode: Schema.optional<Schema.Literals<readonly ["3", "35", "432"]>>;
|
|
480
|
+
}>>;
|
|
481
|
+
/**
|
|
482
|
+
* @description A group of business terms providing information on the invoice period. Also called delivery period. If the group is used, the invoiceing period
|
|
483
|
+
* start date and/or end date must be used.
|
|
484
|
+
*
|
|
485
|
+
* @summary DELIVERY OR INVOICE PERIOD
|
|
486
|
+
*
|
|
487
|
+
* @name `cac:InvoicePeriod`
|
|
488
|
+
*/
|
|
489
|
+
declare class PeppolInvoicePeriod extends PeppolInvoicePeriod_base {}
|
|
490
|
+
//#endregion
|
|
491
|
+
//#region src/schemas/fields/peppol-legal-monetary-total-schema.d.ts
|
|
492
|
+
declare const PeppolLegalMonetaryTotal_base: OpaqueSchema<PeppolLegalMonetaryTotal, Schema.Struct<{
|
|
493
|
+
/**
|
|
494
|
+
* @description Sum of all allowances on document level in the Invoice.
|
|
495
|
+
*
|
|
496
|
+
* @remarks
|
|
497
|
+
* Must be rounded to maxium 2 decimals.
|
|
498
|
+
*
|
|
499
|
+
* @example
|
|
500
|
+
* 200.0;
|
|
501
|
+
*
|
|
502
|
+
* @summary Sum of allowances on document level
|
|
503
|
+
*
|
|
504
|
+
* @name `cbc:AllowanceTotalAmount (+ @currencyID)`
|
|
505
|
+
*/
|
|
506
|
+
readonly allowanceTotalAmount: Schema.optional<typeof PeppolAmount>;
|
|
507
|
+
/**
|
|
508
|
+
* @description Sum of all charges on document level in the Invoice.
|
|
509
|
+
*
|
|
510
|
+
* @remarks
|
|
511
|
+
* Must be rounded to maximum 2 decimals.
|
|
512
|
+
*
|
|
513
|
+
* @example
|
|
514
|
+
* 0.0;
|
|
515
|
+
*
|
|
516
|
+
* @summary Sum of charges on document level
|
|
517
|
+
*
|
|
518
|
+
* @name `cbc:ChargeTotalAmount (+ @currencyID)`
|
|
519
|
+
*/
|
|
520
|
+
readonly chargeTotalAmount: Schema.optional<typeof PeppolAmount>;
|
|
521
|
+
/**
|
|
522
|
+
* @description Sum of all Invoice line net amounts in the Invoice.
|
|
523
|
+
*
|
|
524
|
+
* @remarks
|
|
525
|
+
* Must be rounded to maximum 2 decimals.
|
|
526
|
+
*
|
|
527
|
+
* @example
|
|
528
|
+
* 3800.0;
|
|
529
|
+
*
|
|
530
|
+
* @summary Sum of Invoice line amount
|
|
531
|
+
*
|
|
532
|
+
* @name `cbc:LineExtensionAmount (+ @currencyID)`
|
|
533
|
+
*/
|
|
534
|
+
readonly lineExtensionAmount: typeof PeppolAmount;
|
|
535
|
+
/**
|
|
536
|
+
* @description The amount due for payment on the Invoice, after accounting for all allowances, charges, prepayments, and rounding adjustments.
|
|
537
|
+
*
|
|
538
|
+
* @remarks
|
|
539
|
+
* Must be rounded to maximum 2 decimals.
|
|
540
|
+
*
|
|
541
|
+
* @example
|
|
542
|
+
* 4500.0;
|
|
543
|
+
*
|
|
544
|
+
* @summary Amount due for payment
|
|
545
|
+
*
|
|
546
|
+
* @name `cbc:PayableAmount (+ @currencyID)`
|
|
547
|
+
*/
|
|
548
|
+
readonly payableAmount: typeof PeppolAmount;
|
|
549
|
+
/**
|
|
550
|
+
* @description The rounding amount applied to the Invoice total.
|
|
551
|
+
*
|
|
552
|
+
* @remarks
|
|
553
|
+
* Must be rounded to maximum 2 decimals.
|
|
554
|
+
*
|
|
555
|
+
* @example
|
|
556
|
+
* 0.0;
|
|
557
|
+
*
|
|
558
|
+
* @summary Rounding amount
|
|
559
|
+
*
|
|
560
|
+
* @name `cbc:PayableRoundingAmount (+ @currencyID)`
|
|
561
|
+
*/
|
|
562
|
+
readonly payableRoundingAmount: Schema.optional<typeof PeppolAmount>;
|
|
563
|
+
/**
|
|
564
|
+
* @description The sum of amounts which have been paid in advances.
|
|
565
|
+
*
|
|
566
|
+
* @remarks
|
|
567
|
+
* Must be rounded to maximum 2 decimals.
|
|
568
|
+
*
|
|
569
|
+
* @example
|
|
570
|
+
* 0.0;
|
|
571
|
+
*
|
|
572
|
+
* @summary Paid amount
|
|
573
|
+
*
|
|
574
|
+
* @name `cbc:PrepaidAmount (+ @currencyID)`
|
|
575
|
+
*/
|
|
576
|
+
readonly prepaidAmount: Schema.optional<typeof PeppolAmount>;
|
|
577
|
+
/**
|
|
578
|
+
* @description The total amount of the Invoice without VAT.
|
|
579
|
+
*
|
|
580
|
+
* @remarks
|
|
581
|
+
* Must be rounded to maximum 2 decimals.
|
|
582
|
+
*
|
|
583
|
+
* @example
|
|
584
|
+
* 3600.0;
|
|
585
|
+
*
|
|
586
|
+
* @summary Invoice total amount without VAT
|
|
587
|
+
*
|
|
588
|
+
* @name `cbc:TaxExclusiveAmount (+ @currencyID)`
|
|
589
|
+
*/
|
|
590
|
+
readonly taxExclusiveAmount: typeof PeppolAmount;
|
|
591
|
+
/**
|
|
592
|
+
* @description The total amount of the Invoice with VAT.
|
|
593
|
+
*
|
|
594
|
+
* @example
|
|
595
|
+
* 4500.0;
|
|
596
|
+
*
|
|
597
|
+
* @summary Invoice total amount with VAT
|
|
598
|
+
*
|
|
599
|
+
* @remark Must be rounded to maximum 2 decimals.
|
|
600
|
+
*
|
|
601
|
+
* @name `cbc:TaxInclusiveAmount (+ @currencyID)`
|
|
602
|
+
*/
|
|
603
|
+
readonly taxInclusiveAmount: typeof PeppolAmount;
|
|
604
|
+
}>>;
|
|
605
|
+
/**
|
|
606
|
+
* @description A group of business terms providing the monetary totals for the Invoice.
|
|
607
|
+
*
|
|
608
|
+
* @summary Document totals
|
|
609
|
+
*
|
|
610
|
+
* @name cac:LegalMonetaryTotal
|
|
611
|
+
*/
|
|
612
|
+
declare class PeppolLegalMonetaryTotal extends PeppolLegalMonetaryTotal_base {}
|
|
613
|
+
//#endregion
|
|
614
|
+
//#region src/schemas/fields/peppol-order-reference-schema.d.ts
|
|
615
|
+
declare const PeppolOrderReference_base: OpaqueSchema<PeppolOrderReference, Schema.Struct<{
|
|
616
|
+
/**
|
|
617
|
+
* @description An identifier of a referenced purchase order, issued by the Buyer. An identifier of a referenced purchase order, issued by the Buyer. An
|
|
618
|
+
* invoice must have buyer reference (BT-10) or purchase order reference. In cases where sales order reference is provided, but there's no
|
|
619
|
+
* purchase order reference, then use value "NA" as this element is mandatory in UBL.
|
|
620
|
+
*
|
|
621
|
+
* @example
|
|
622
|
+
* `98776`;
|
|
623
|
+
*
|
|
624
|
+
* @summary Purchase order reference
|
|
625
|
+
*
|
|
626
|
+
* @name `cbc:ID`
|
|
627
|
+
*/
|
|
628
|
+
readonly id: Schema.String;
|
|
629
|
+
/**
|
|
630
|
+
* @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
|
|
631
|
+
* order reference, then set cac:OrderReference/cbc:ID to value "NA" as this element is mandatory in UBL.
|
|
632
|
+
*
|
|
633
|
+
* @example
|
|
634
|
+
* `112233`;
|
|
635
|
+
*
|
|
636
|
+
* @summary Sales order reference
|
|
637
|
+
*
|
|
638
|
+
* @name `cbc:SalesOrderID`
|
|
639
|
+
*/
|
|
640
|
+
readonly salesOrderId: Schema.optional<Schema.String>;
|
|
641
|
+
}>>;
|
|
642
|
+
/**
|
|
643
|
+
* @summary ORDER AND SALES ORDER REFERENCE
|
|
644
|
+
*
|
|
645
|
+
* @name cac:OrderReference
|
|
646
|
+
*/
|
|
647
|
+
declare class PeppolOrderReference extends PeppolOrderReference_base {}
|
|
648
|
+
//#endregion
|
|
649
|
+
//#region src/schemas/fields/peppol-contact-schema.d.ts
|
|
650
|
+
declare const PeppolContact_base: OpaqueSchema<PeppolContact, Schema.Struct<{
|
|
651
|
+
/**
|
|
652
|
+
* @name cbc:ElectronicMail
|
|
653
|
+
*/
|
|
654
|
+
readonly electronicMail: Schema.optional<Schema.String>;
|
|
655
|
+
/**
|
|
656
|
+
* @name cbc:Name
|
|
657
|
+
*/
|
|
658
|
+
readonly name: Schema.optional<Schema.String>;
|
|
659
|
+
/**
|
|
660
|
+
* @name cbc:Telephone
|
|
661
|
+
*/
|
|
662
|
+
readonly telephone: Schema.optional<Schema.String>;
|
|
663
|
+
}>>;
|
|
664
|
+
declare class PeppolContact extends PeppolContact_base {}
|
|
665
|
+
//#endregion
|
|
666
|
+
//#region src/schemas/fields/peppol-identifier-schema.d.ts
|
|
667
|
+
declare const PeppolIdentifier_base: OpaqueSchema<PeppolIdentifier, Schema.Struct<{
|
|
668
|
+
/**
|
|
669
|
+
* @name cbc:ID
|
|
670
|
+
*/
|
|
671
|
+
readonly id: Schema.String;
|
|
672
|
+
/**
|
|
673
|
+
* @name `@schemeID`
|
|
674
|
+
*/
|
|
675
|
+
readonly schemeId: Schema.optional<Schema.String>;
|
|
676
|
+
}>>;
|
|
677
|
+
/**
|
|
678
|
+
* @summary Identifier with optional scheme
|
|
679
|
+
*
|
|
680
|
+
* @name `cbc:ID (+ optional @schemeID)`
|
|
681
|
+
*/
|
|
682
|
+
declare class PeppolIdentifier extends PeppolIdentifier_base {}
|
|
683
|
+
//#endregion
|
|
684
|
+
//#region src/schemas/fields/peppol-party-legal-entity-schema.d.ts
|
|
685
|
+
declare const PeppolPartyLegalEntity_base$1: OpaqueSchema<PeppolPartyLegalEntity$1, Schema.Struct<{
|
|
686
|
+
/**
|
|
687
|
+
* @example
|
|
688
|
+
* 987654321;
|
|
689
|
+
*
|
|
690
|
+
* @name cbc:CompanyID (+ @schemeID)
|
|
691
|
+
*/
|
|
692
|
+
readonly companyId: Schema.optional<typeof PeppolIdentifier>;
|
|
693
|
+
/**
|
|
694
|
+
* @example
|
|
695
|
+
* Share capital
|
|
696
|
+
*
|
|
697
|
+
* @name cbc:CompanyLegalForm
|
|
698
|
+
*/
|
|
699
|
+
readonly companyLegalForm: Schema.optional<Schema.String>;
|
|
700
|
+
/**
|
|
701
|
+
* @example
|
|
702
|
+
* Full Formal Seller Name LTD.
|
|
703
|
+
*
|
|
704
|
+
* @name cbc:RegistrationName
|
|
705
|
+
*/
|
|
706
|
+
readonly registrationName: Schema.String;
|
|
707
|
+
}>>;
|
|
708
|
+
declare class PeppolPartyLegalEntity$1 extends PeppolPartyLegalEntity_base$1 {}
|
|
709
|
+
type PeppolPartyLegalEntitySchema = PeppolPartyLegalEntity$1;
|
|
710
|
+
//#endregion
|
|
711
|
+
//#region src/schemas/fields/peppol-party-tax-scheme-schema.d.ts
|
|
712
|
+
declare const PeppolTaxSchemeId_base$1: OpaqueSchema<PeppolTaxSchemeId$1, Schema.Struct<{
|
|
713
|
+
/**
|
|
714
|
+
* @description Mandatory element. For Seller VAT identifier (BT-31), use value “VAT”, for the seller tax registration identifier (BT-32), use != "VAT"
|
|
715
|
+
*
|
|
716
|
+
* @name cbc:ID
|
|
717
|
+
*/
|
|
718
|
+
readonly id: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
719
|
+
}>>;
|
|
720
|
+
declare class PeppolTaxSchemeId$1 extends PeppolTaxSchemeId_base$1 {}
|
|
721
|
+
declare const PeppolPartyTaxScheme_base: OpaqueSchema<PeppolPartyTaxScheme, Schema.Struct<{
|
|
722
|
+
/**
|
|
723
|
+
* @description The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of
|
|
724
|
+
* 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
|
|
725
|
+
* identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31)
|
|
726
|
+
* shall be present.
|
|
727
|
+
*
|
|
728
|
+
* @summary Seller VAT identifier, Seller tax registration identifier
|
|
729
|
+
*
|
|
730
|
+
* @name `cbc:CompanyID`
|
|
731
|
+
*/
|
|
732
|
+
readonly companyId: Schema.String;
|
|
733
|
+
/**
|
|
734
|
+
* @description Mandatory element. For Seller VAT identifier (BT-31), use value “VAT”, for the seller tax registration identifier (BT-32), use != "VAT"
|
|
735
|
+
*
|
|
736
|
+
* @name `cac:TaxScheme`
|
|
737
|
+
*/
|
|
738
|
+
readonly taxSchemeId: typeof PeppolTaxSchemeId$1;
|
|
739
|
+
}>>;
|
|
740
|
+
/**
|
|
741
|
+
* @name cac:PartyTaxScheme (0..2)
|
|
742
|
+
*/
|
|
743
|
+
declare class PeppolPartyTaxScheme extends PeppolPartyTaxScheme_base {}
|
|
744
|
+
type PeppolPartyTaxSchema = PeppolPartyTaxScheme;
|
|
745
|
+
//#endregion
|
|
746
|
+
//#region src/schemas/fields/peppol-party-base-schema.d.ts
|
|
747
|
+
declare const PeppolPartyName_base$1: OpaqueSchema<PeppolPartyName$1, Schema.Struct<{
|
|
748
|
+
/**
|
|
749
|
+
* @description A name by which the Buyer/Seller is known, other than Buyer/Seller name (also known as Business name).
|
|
750
|
+
*
|
|
751
|
+
* @example
|
|
752
|
+
* `Trading Name`;
|
|
753
|
+
*
|
|
754
|
+
* @summary Buyer/Seller trading name
|
|
755
|
+
*/
|
|
756
|
+
readonly name: Schema.String;
|
|
757
|
+
}>>;
|
|
758
|
+
declare class PeppolPartyName$1 extends PeppolPartyName_base$1 {}
|
|
759
|
+
declare const PeppolPartyIdentification_base$1: OpaqueSchema<PeppolPartyIdentification$1, Schema.Struct<{
|
|
760
|
+
/**
|
|
761
|
+
* @description An identifier of the Buyer/seller.
|
|
762
|
+
*
|
|
763
|
+
* @summary Buyer/seller identifier
|
|
764
|
+
*
|
|
765
|
+
* @name `cbc:ID`
|
|
766
|
+
*/
|
|
767
|
+
readonly id: Schema.Struct<{
|
|
768
|
+
readonly id: Schema.String;
|
|
769
|
+
readonly schemeId: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolIcdCode">>;
|
|
770
|
+
}>;
|
|
771
|
+
}>>;
|
|
772
|
+
declare class PeppolPartyIdentification$1 extends PeppolPartyIdentification_base$1 {}
|
|
773
|
+
declare const PeppolPartyEndpointId_base: OpaqueSchema<PeppolPartyEndpointId, Schema.Struct<{
|
|
774
|
+
readonly id: Schema.String;
|
|
775
|
+
readonly schemeId: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolElectronicAddressCode">;
|
|
776
|
+
}>>;
|
|
777
|
+
declare class PeppolPartyEndpointId extends PeppolPartyEndpointId_base {}
|
|
778
|
+
declare const PeppolPartySchema_base: OpaqueSchema<PeppolPartySchema, Schema.Struct<{
|
|
779
|
+
/**
|
|
780
|
+
* @description Identifies the Seller/buyer's electronic address to which the application level response to the invoice may be delivered.
|
|
781
|
+
*
|
|
782
|
+
* @example
|
|
783
|
+
* 7300010000001;
|
|
784
|
+
*
|
|
785
|
+
* @summary Seller/Buyer electronic address
|
|
786
|
+
*
|
|
787
|
+
* @name `cbc:EndpointID`
|
|
788
|
+
*/
|
|
789
|
+
readonly endpointId: typeof PeppolPartyEndpointId;
|
|
790
|
+
/**
|
|
791
|
+
* @example
|
|
792
|
+
* 5060012349998;
|
|
793
|
+
*
|
|
794
|
+
* @summary PARTY IDENTIFICATION
|
|
795
|
+
*
|
|
796
|
+
* @name `cac:PartyIdentification`
|
|
797
|
+
*/
|
|
798
|
+
readonly partyIdentification: Schema.optional<typeof PeppolPartyIdentification$1>;
|
|
799
|
+
/**
|
|
800
|
+
* @example
|
|
801
|
+
* Seller Business Name AS
|
|
802
|
+
*
|
|
803
|
+
* @summary PARTY NAME
|
|
804
|
+
*
|
|
805
|
+
* @name cac:PartyName
|
|
806
|
+
*/
|
|
807
|
+
readonly partyName: Schema.optional<typeof PeppolPartyName$1>;
|
|
808
|
+
/**
|
|
809
|
+
* @name cac:PostalAddress
|
|
810
|
+
*/
|
|
811
|
+
readonly postalAddress: typeof PeppolAddress;
|
|
812
|
+
/**
|
|
813
|
+
* @remarks
|
|
814
|
+
* Max 1 for a buyer, max 2 for a seller.
|
|
815
|
+
*
|
|
816
|
+
* @name cac:PartyTaxScheme
|
|
817
|
+
*
|
|
818
|
+
* @cardinality (0..2)
|
|
819
|
+
*/
|
|
820
|
+
readonly partyTaxSchemes: Schema.optional<Schema.$Array<typeof PeppolPartyTaxScheme>>;
|
|
821
|
+
/**
|
|
822
|
+
* @name cac:PartyLegalEntity
|
|
823
|
+
*/
|
|
824
|
+
readonly partyLegalEntity: typeof PeppolPartyLegalEntity$1;
|
|
825
|
+
/**
|
|
826
|
+
* @name cac:Contact
|
|
827
|
+
*/
|
|
828
|
+
readonly contact: Schema.optional<typeof PeppolContact>;
|
|
829
|
+
}>>;
|
|
830
|
+
/**
|
|
831
|
+
* @summary Party common substructure
|
|
832
|
+
*
|
|
833
|
+
* @name cac:Party
|
|
834
|
+
*/
|
|
835
|
+
declare class PeppolPartySchema extends PeppolPartySchema_base {}
|
|
836
|
+
//#endregion
|
|
837
|
+
//#region src/schemas/fields/peppol-payee-party-schema.d.ts
|
|
838
|
+
declare const PeppolPartyName_base: OpaqueSchema<PeppolPartyName, Schema.Struct<{
|
|
839
|
+
readonly name: Schema.String;
|
|
840
|
+
}>>;
|
|
841
|
+
declare class PeppolPartyName extends PeppolPartyName_base {}
|
|
842
|
+
declare const PeppolPartyLegalEntity_base: OpaqueSchema<PeppolPartyLegalEntity, Schema.Struct<{
|
|
843
|
+
/**
|
|
844
|
+
* @description An identifier issued by an official registrar that identifies the payee as a legal entity or person.
|
|
845
|
+
*
|
|
846
|
+
* @example
|
|
847
|
+
* `FR932874294`;
|
|
848
|
+
*
|
|
849
|
+
* @summary Payee legal registration identifier
|
|
850
|
+
*
|
|
851
|
+
* @name `cbc:CompanyID`
|
|
852
|
+
*/
|
|
853
|
+
readonly companyId: Schema.optional<Schema.Struct<{
|
|
854
|
+
readonly id: Schema.String;
|
|
855
|
+
readonly schemeId: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolIcdCode">>;
|
|
856
|
+
}>>;
|
|
857
|
+
}>>;
|
|
858
|
+
declare class PeppolPartyLegalEntity extends PeppolPartyLegalEntity_base {}
|
|
859
|
+
declare const PeppolPartyIdentification_base: OpaqueSchema<PeppolPartyIdentification, Schema.Struct<{
|
|
860
|
+
/**
|
|
861
|
+
* @description This element is used for both the identification of the Payee, or the unique banking reference identifier of Payee (assigned by the Payee
|
|
862
|
+
* bank.) For payee identification use ICD code list, for SEPA bank assigned creditor reference, use SEPA.
|
|
863
|
+
*
|
|
864
|
+
* @summary Payee identifier or bank assigned crditor identifier
|
|
865
|
+
*
|
|
866
|
+
* @name `cbc:ID`
|
|
867
|
+
*/
|
|
868
|
+
readonly id: Schema.optional<Schema.Struct<{
|
|
869
|
+
readonly id: Schema.String;
|
|
870
|
+
readonly schemeId: Schema.optional<Schema.String>;
|
|
871
|
+
}>>;
|
|
872
|
+
}>>;
|
|
873
|
+
declare class PeppolPartyIdentification extends PeppolPartyIdentification_base {}
|
|
874
|
+
declare const PeppolPayeeParty_base: OpaqueSchema<PeppolPayeeParty, Schema.Struct<{
|
|
875
|
+
/**
|
|
876
|
+
* @summary PARTY IDENTIFICATION
|
|
877
|
+
*
|
|
878
|
+
* @name `cac:PartyIdentification`
|
|
879
|
+
*/
|
|
880
|
+
readonly partyIdentification: Schema.optional<typeof PeppolPartyIdentification>;
|
|
881
|
+
/**
|
|
882
|
+
* @summary PARTY LEGAL ENTITY
|
|
883
|
+
*
|
|
884
|
+
* @name `cac:PartyLegalEntity`
|
|
885
|
+
*/
|
|
886
|
+
readonly partyLegalEntity: Schema.optional<typeof PeppolPartyLegalEntity>;
|
|
887
|
+
/**
|
|
888
|
+
* @description The name of the payee.
|
|
889
|
+
*
|
|
890
|
+
* @example
|
|
891
|
+
* `Payee Name Ltd`;
|
|
892
|
+
*
|
|
893
|
+
* @summary Payee name
|
|
894
|
+
*
|
|
895
|
+
* @name `cac:PartyName`
|
|
896
|
+
*/
|
|
897
|
+
readonly partyName: typeof PeppolPartyName;
|
|
898
|
+
}>>;
|
|
899
|
+
/**
|
|
900
|
+
* @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
|
|
901
|
+
* different from the seller.
|
|
902
|
+
*
|
|
903
|
+
* @summary PAYEE
|
|
904
|
+
*
|
|
905
|
+
* @name cac:PayeeParty
|
|
906
|
+
*/
|
|
907
|
+
declare class PeppolPayeeParty extends PeppolPayeeParty_base {}
|
|
908
|
+
//#endregion
|
|
909
|
+
//#region src/schemas/fields/peppol-payment-means-schema.d.ts
|
|
910
|
+
declare const PeppolPaymentMandatePayerFinancialAccountId_base: OpaqueSchema<PeppolPaymentMandatePayerFinancialAccountId, Schema.Struct<{
|
|
911
|
+
/**
|
|
912
|
+
* @description The account to be debited by the direct debit.
|
|
913
|
+
*
|
|
914
|
+
* @example
|
|
915
|
+
* `12345676543`;
|
|
916
|
+
*
|
|
917
|
+
* @summary Debited account identifier
|
|
918
|
+
*
|
|
919
|
+
* @name `cbc:ID`
|
|
920
|
+
*/
|
|
921
|
+
readonly id: Schema.String;
|
|
922
|
+
}>>;
|
|
923
|
+
declare class PeppolPaymentMandatePayerFinancialAccountId extends PeppolPaymentMandatePayerFinancialAccountId_base {}
|
|
924
|
+
declare const PeppolPaymentMandate_base: OpaqueSchema<PeppolPaymentMandate, Schema.Struct<{
|
|
925
|
+
/**
|
|
926
|
+
* @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.
|
|
927
|
+
*
|
|
928
|
+
* @summary Mandate reference identifier
|
|
929
|
+
*
|
|
930
|
+
* @name cbc:ID
|
|
931
|
+
*/
|
|
932
|
+
readonly id: Schema.optional<Schema.String>;
|
|
933
|
+
/**
|
|
934
|
+
* @description The account to be debited by the direct debit.
|
|
935
|
+
*
|
|
936
|
+
* @example
|
|
937
|
+
* `12345676543`;
|
|
938
|
+
*
|
|
939
|
+
* @summary Debited account identifier
|
|
940
|
+
*
|
|
941
|
+
* @name `cac:PayerFinancialAccount`
|
|
942
|
+
*/
|
|
943
|
+
readonly payerFinancialAccountId: Schema.optional<typeof PeppolPaymentMandatePayerFinancialAccountId>;
|
|
944
|
+
}>>;
|
|
945
|
+
declare class PeppolPaymentMandate extends PeppolPaymentMandate_base {}
|
|
946
|
+
declare const PeppolPayeeFinancialAccountFinancialInstitutionBranch_base: OpaqueSchema<PeppolPayeeFinancialAccountFinancialInstitutionBranch, Schema.Struct<{
|
|
947
|
+
/**
|
|
948
|
+
* @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
|
|
949
|
+
* identification scheme Identifier to be used.
|
|
950
|
+
*
|
|
951
|
+
* @example
|
|
952
|
+
* `9998`;
|
|
953
|
+
*
|
|
954
|
+
* @summary Payment service provider identifier
|
|
955
|
+
*
|
|
956
|
+
* @name `cac:FinancialInstitutionBranch`
|
|
957
|
+
*/
|
|
958
|
+
readonly id: Schema.String;
|
|
959
|
+
}>>;
|
|
960
|
+
declare class PeppolPayeeFinancialAccountFinancialInstitutionBranch extends PeppolPayeeFinancialAccountFinancialInstitutionBranch_base {}
|
|
961
|
+
declare const PeppolPayeeFinancialAccount_base: OpaqueSchema<PeppolPayeeFinancialAccount, Schema.Struct<{
|
|
962
|
+
/**
|
|
963
|
+
* @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
|
|
964
|
+
* identification scheme Identifier to be used.
|
|
965
|
+
*
|
|
966
|
+
* @example
|
|
967
|
+
* `9998`;
|
|
968
|
+
*
|
|
969
|
+
* @summary Payment service provider identifier
|
|
970
|
+
*
|
|
971
|
+
* @name `cac:FinancialInstitutionBranch`
|
|
972
|
+
*/
|
|
973
|
+
readonly financialInstitutionBranch: Schema.optional<typeof PeppolPayeeFinancialAccountFinancialInstitutionBranch>;
|
|
974
|
+
/**
|
|
975
|
+
* @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.
|
|
976
|
+
*
|
|
977
|
+
* @summary Payment account identifier
|
|
978
|
+
*
|
|
979
|
+
* @name cbc:ID
|
|
980
|
+
*/
|
|
981
|
+
readonly id: Schema.String;
|
|
982
|
+
/**
|
|
983
|
+
* @description The name of the payment account, at a payment service provider, to which payment should be made.
|
|
984
|
+
*
|
|
985
|
+
* @summary Payment account name
|
|
986
|
+
*
|
|
987
|
+
* @name cbc:Name
|
|
988
|
+
*/
|
|
989
|
+
readonly name: Schema.optional<Schema.String>;
|
|
990
|
+
}>>;
|
|
991
|
+
declare class PeppolPayeeFinancialAccount extends PeppolPayeeFinancialAccount_base {}
|
|
992
|
+
declare const PeppolCardAccount_base: OpaqueSchema<PeppolCardAccount, Schema.Struct<{
|
|
993
|
+
/**
|
|
994
|
+
* @description The name of the payment card holder.
|
|
995
|
+
*
|
|
996
|
+
* @summary Payment card holder name
|
|
997
|
+
*
|
|
998
|
+
* @name cbc:HolderName
|
|
999
|
+
*/
|
|
1000
|
+
readonly holderName: Schema.optional<Schema.String>;
|
|
1001
|
+
/**
|
|
1002
|
+
* @summary Syntax required element not related to a business term.
|
|
1003
|
+
*
|
|
1004
|
+
* @name cbc:NetworkID
|
|
1005
|
+
*/
|
|
1006
|
+
readonly networkId: Schema.String;
|
|
1007
|
+
/**
|
|
1008
|
+
* @description The Primary Account Number (PAN) of the card used for payment. In accordance with card payments security standards, an invoice should never
|
|
1009
|
+
* include a full card primary account number.
|
|
1010
|
+
*
|
|
1011
|
+
* @example
|
|
1012
|
+
* `1234`;
|
|
1013
|
+
*
|
|
1014
|
+
* @summary Payment card primary account number
|
|
1015
|
+
*
|
|
1016
|
+
* @name cbc:PrimaryAccountNumberID
|
|
1017
|
+
*/
|
|
1018
|
+
readonly primaryAccountNumberId: Schema.String;
|
|
1019
|
+
}>>;
|
|
1020
|
+
declare class PeppolCardAccount extends PeppolCardAccount_base {}
|
|
1021
|
+
declare const PeppolPaymentMeansCode_base: OpaqueSchema<PeppolPaymentMeansCode$1, Schema.Struct<{
|
|
1022
|
+
/**
|
|
1023
|
+
* @description The means, expressed as code, for how a payment is expected to be or has been settled.
|
|
1024
|
+
*
|
|
1025
|
+
* @example
|
|
1026
|
+
* 30;
|
|
1027
|
+
*
|
|
1028
|
+
* @summary Payment means type code
|
|
1029
|
+
*
|
|
1030
|
+
* @name `#text`
|
|
1031
|
+
*/
|
|
1032
|
+
readonly code: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolPaymentMeansCode">;
|
|
1033
|
+
/**
|
|
1034
|
+
* @description The means, expressed as text, for how a payment is expected to be or has been settled.
|
|
1035
|
+
*
|
|
1036
|
+
* @example
|
|
1037
|
+
* Credit transfer
|
|
1038
|
+
*
|
|
1039
|
+
* @summary Payment means text
|
|
1040
|
+
*
|
|
1041
|
+
* @name `@name`
|
|
1042
|
+
*/
|
|
1043
|
+
readonly name: Schema.optional<Schema.String>;
|
|
1044
|
+
}>>;
|
|
1045
|
+
declare class PeppolPaymentMeansCode$1 extends PeppolPaymentMeansCode_base {}
|
|
1046
|
+
declare const PeppolPaymentMeans_base: OpaqueSchema<PeppolPaymentMeans, Schema.Struct<{
|
|
1047
|
+
/**
|
|
1048
|
+
* @description The means, expressed as code, for how a payment is expected to be or has been settled.
|
|
1049
|
+
*
|
|
1050
|
+
* @example
|
|
1051
|
+
* 30;
|
|
1052
|
+
*
|
|
1053
|
+
* @summary Payment means type code
|
|
1054
|
+
*
|
|
1055
|
+
* @name `cbc:PaymentMeansCode`
|
|
1056
|
+
*/
|
|
1057
|
+
readonly paymentMeansCode: typeof PeppolPaymentMeansCode$1;
|
|
1058
|
+
/**
|
|
1059
|
+
* @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
|
|
1060
|
+
* (BT-9) or the Payment terms (BT-20) shall be present.
|
|
1061
|
+
*
|
|
1062
|
+
* @remarks
|
|
1063
|
+
* This should only be used with a credit note.
|
|
1064
|
+
*
|
|
1065
|
+
* @summary Payment due date
|
|
1066
|
+
*
|
|
1067
|
+
* @name `cbc:PaymentDueDate`
|
|
1068
|
+
*/
|
|
1069
|
+
readonly paymentDueDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
1070
|
+
/**
|
|
1071
|
+
* @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
|
|
1072
|
+
* information. This information element helps the Seller to assign an incoming payment to the relevant payment process.
|
|
1073
|
+
*
|
|
1074
|
+
* @example
|
|
1075
|
+
* `432948234234234`;
|
|
1076
|
+
*
|
|
1077
|
+
* @summary Remittance information
|
|
1078
|
+
*
|
|
1079
|
+
* @name cbc:PaymentID
|
|
1080
|
+
*/
|
|
1081
|
+
readonly paymentId: Schema.optional<Schema.String>;
|
|
1082
|
+
/**
|
|
1083
|
+
* @description A group of business terms providing information about card used for payment contemporaneous with invoice issuance.
|
|
1084
|
+
*
|
|
1085
|
+
* @summary PAYMENT CARD INFORMATION
|
|
1086
|
+
*
|
|
1087
|
+
* @name cac:CardAccount
|
|
1088
|
+
*/
|
|
1089
|
+
readonly cardAccount: Schema.optional<typeof PeppolCardAccount>;
|
|
1090
|
+
/**
|
|
1091
|
+
* @description A group of business terms to specify credit transfer payments.
|
|
1092
|
+
*
|
|
1093
|
+
* @summary CREDIT TRANSFER
|
|
1094
|
+
*
|
|
1095
|
+
* @name cac:PayeeFinancialAccount
|
|
1096
|
+
*/
|
|
1097
|
+
readonly payeeFinancialAccount: Schema.optional<typeof PeppolPayeeFinancialAccount>;
|
|
1098
|
+
/**
|
|
1099
|
+
* @description A group of business terms to specify a direct debit.
|
|
1100
|
+
*
|
|
1101
|
+
* @summary DIRECT DEBIT
|
|
1102
|
+
*
|
|
1103
|
+
* @name cac:PaymentMandate
|
|
1104
|
+
*/
|
|
1105
|
+
readonly paymentMandate: Schema.optional<typeof PeppolPaymentMandate>;
|
|
1106
|
+
}>>;
|
|
1107
|
+
/**
|
|
1108
|
+
* @description A group of business terms providing information about the payment.
|
|
1109
|
+
*
|
|
1110
|
+
* @summary Payment means (credit transfer/direct debit/card)
|
|
1111
|
+
*
|
|
1112
|
+
* @name cac:PaymentMeans
|
|
1113
|
+
*/
|
|
1114
|
+
declare class PeppolPaymentMeans extends PeppolPaymentMeans_base {}
|
|
1115
|
+
//#endregion
|
|
1116
|
+
//#region src/schemas/fields/peppol-payment-terms-schema.d.ts
|
|
1117
|
+
declare const PeppolPaymentTerms_base: OpaqueSchema<PeppolPaymentTerms, Schema.Struct<{
|
|
1118
|
+
/**
|
|
1119
|
+
* @description A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties). In case the
|
|
1120
|
+
* Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
|
|
1121
|
+
*
|
|
1122
|
+
* @example
|
|
1123
|
+
* Net within 30 days
|
|
1124
|
+
*
|
|
1125
|
+
* @summary Payment terms
|
|
1126
|
+
*
|
|
1127
|
+
* @name cbc:Note
|
|
1128
|
+
*/
|
|
1129
|
+
readonly note: Schema.String;
|
|
1130
|
+
}>>;
|
|
1131
|
+
/**
|
|
1132
|
+
* @summary PAYMENT TERMS
|
|
1133
|
+
*
|
|
1134
|
+
* @name cac:PaymentTerms
|
|
1135
|
+
*/
|
|
1136
|
+
declare class PeppolPaymentTerms extends PeppolPaymentTerms_base {}
|
|
1137
|
+
//#endregion
|
|
1138
|
+
//#region src/schemas/fields/peppol-tax-representative-schema.d.ts
|
|
1139
|
+
declare const PeppolTaxRepresentative_base: OpaqueSchema<PeppolTaxRepresentative, Schema.Struct<{
|
|
1140
|
+
/**
|
|
1141
|
+
* @name cac:PartyName/cbc:Name
|
|
1142
|
+
*/
|
|
1143
|
+
readonly name: Schema.String;
|
|
1144
|
+
/**
|
|
1145
|
+
* @name cac:PostalAddress
|
|
1146
|
+
*/
|
|
1147
|
+
readonly postalAddress: typeof PeppolAddress;
|
|
1148
|
+
readonly partyTaxScheme: typeof PeppolPartyTaxScheme;
|
|
1149
|
+
}>>;
|
|
1150
|
+
/**
|
|
1151
|
+
* @summary SELLER TAX REPRESENTATIVE PARTY
|
|
1152
|
+
*
|
|
1153
|
+
* @name cac:TaxRepresentativeParty
|
|
1154
|
+
*/
|
|
1155
|
+
declare class PeppolTaxRepresentative extends PeppolTaxRepresentative_base {}
|
|
1156
|
+
type PeppolTaxRepresentativeParty = PeppolTaxRepresentative;
|
|
1157
|
+
//#endregion
|
|
1158
|
+
//#region src/schemas/fields/peppol-tax-category-schema.d.ts
|
|
1159
|
+
declare const PeppolTaxSchemeId_base: OpaqueSchema<PeppolTaxSchemeId, Schema.Struct<{
|
|
1160
|
+
/**
|
|
1161
|
+
* @name `cbc:ID`
|
|
1162
|
+
*/
|
|
1163
|
+
readonly id: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
1164
|
+
}>>;
|
|
1165
|
+
declare class PeppolTaxSchemeId extends PeppolTaxSchemeId_base {}
|
|
1166
|
+
declare const PeppolTaxCategory_base: OpaqueSchema<PeppolTaxCategory, Schema.Struct<{
|
|
1167
|
+
/**
|
|
1168
|
+
* @description The VAT category code for the invoiced item.
|
|
1169
|
+
*
|
|
1170
|
+
* @summary Invoiced item VAT category code
|
|
1171
|
+
*
|
|
1172
|
+
* @name `cbc:ID`
|
|
1173
|
+
*/
|
|
1174
|
+
readonly id: Schema.brand<Schema.Literals<readonly ["AE", "E", "S", "Z", "G", "O", "K", "L", "M", "B"]>, "PeppolDutyTaxFeeCategoryCode">;
|
|
1175
|
+
/**
|
|
1176
|
+
* @description The VAT rate, represented as percentage that applies to the invoiced item.
|
|
1177
|
+
*
|
|
1178
|
+
* @summary Invoiced item VAT rate
|
|
1179
|
+
*
|
|
1180
|
+
* @name `cbc:Percent`
|
|
1181
|
+
*/
|
|
1182
|
+
readonly percent: Schema.optional<Schema.Finite>;
|
|
1183
|
+
/**
|
|
1184
|
+
* @default VAT
|
|
1185
|
+
*
|
|
1186
|
+
* @name `cac:TaxScheme`
|
|
1187
|
+
*/
|
|
1188
|
+
readonly taxSchemeId: typeof PeppolTaxSchemeId;
|
|
1189
|
+
}>>;
|
|
1190
|
+
/**
|
|
1191
|
+
* @description A group of business terms providing information about the VAT applicable for the goods and services invoiced on the Invoice line.
|
|
1192
|
+
*
|
|
1193
|
+
* @summary LINE VAT INFORMATION
|
|
1194
|
+
*
|
|
1195
|
+
* @name `cac:TaxCategory`
|
|
1196
|
+
*/
|
|
1197
|
+
declare class PeppolTaxCategory extends PeppolTaxCategory_base {}
|
|
1198
|
+
//#endregion
|
|
1199
|
+
//#region src/schemas/fields/peppol-tax-subtotal-category-schema.d.ts
|
|
1200
|
+
declare const PeppolTaxSubTotalCategory_base: OpaqueSchema<PeppolTaxSubTotalCategory, Schema.Struct<{
|
|
1201
|
+
readonly id: Schema.brand<Schema.Literals<readonly ["AE", "E", "S", "Z", "G", "O", "K", "L", "M", "B"]>, "PeppolDutyTaxFeeCategoryCode">;
|
|
1202
|
+
readonly percent: Schema.optional<Schema.Finite>;
|
|
1203
|
+
readonly taxSchemeId: typeof PeppolTaxSchemeId;
|
|
1204
|
+
/**
|
|
1205
|
+
* @description The reason for the tax exemption.
|
|
1206
|
+
*
|
|
1207
|
+
* @name cbc:TaxExemptionReason
|
|
1208
|
+
*/
|
|
1209
|
+
readonly taxExemptionReason: Schema.optional<Schema.String>;
|
|
1210
|
+
/**
|
|
1211
|
+
* @description The code for the reason of the tax exemption.
|
|
1212
|
+
*
|
|
1213
|
+
* @name cbc:TaxExemptionReasonCode
|
|
1214
|
+
*/
|
|
1215
|
+
readonly taxExemptionReasonCode: Schema.optional<Schema.String>;
|
|
1216
|
+
}>>;
|
|
1217
|
+
/**
|
|
1218
|
+
* @description This one is specific for TaxSubtotal since it includes more fields.
|
|
1219
|
+
*
|
|
1220
|
+
* @summary Tax Category for Tax Subtotal
|
|
1221
|
+
*
|
|
1222
|
+
* @name cac:TaxCategory
|
|
1223
|
+
*/
|
|
1224
|
+
declare class PeppolTaxSubTotalCategory extends PeppolTaxSubTotalCategory_base {}
|
|
1225
|
+
interface PeppolTaxSubTotalCategoryEncoded extends Schema.Codec.Encoded<typeof PeppolTaxSubTotalCategory> {}
|
|
1226
|
+
//#endregion
|
|
1227
|
+
//#region src/schemas/fields/peppol-tax-subtotal-schema.d.ts
|
|
1228
|
+
declare const PeppolTaxSubTotal_base: OpaqueSchema<PeppolTaxSubTotal, Schema.Struct<{
|
|
1229
|
+
/**
|
|
1230
|
+
* @description The amount of tax for the tax subtotal.
|
|
1231
|
+
*
|
|
1232
|
+
* @name `cbc:TaxAmount (+ @currencyID)`
|
|
1233
|
+
*/
|
|
1234
|
+
readonly taxAmount: typeof PeppolAmount;
|
|
1235
|
+
/**
|
|
1236
|
+
* @description The tax category associated with this tax subtotal.
|
|
1237
|
+
*
|
|
1238
|
+
* @name cac:TaxCategory
|
|
1239
|
+
*/
|
|
1240
|
+
readonly taxCategory: typeof PeppolTaxSubTotalCategory;
|
|
1241
|
+
/**
|
|
1242
|
+
* @description The taxable amount for the tax subtotal.
|
|
1243
|
+
*
|
|
1244
|
+
* @name `cbc:TaxableAmount (+ @currencyID)`
|
|
1245
|
+
*/
|
|
1246
|
+
readonly taxableAmount: typeof PeppolAmount;
|
|
1247
|
+
}>>;
|
|
1248
|
+
/**
|
|
1249
|
+
* @summary VAT breakdown (TaxSubtotal)
|
|
1250
|
+
*
|
|
1251
|
+
* @name cac:TaxSubtotal
|
|
1252
|
+
*/
|
|
1253
|
+
declare class PeppolTaxSubTotal extends PeppolTaxSubTotal_base {}
|
|
1254
|
+
//#endregion
|
|
1255
|
+
//#region src/schemas/fields/peppol-tax-totals-base-schema.d.ts
|
|
1256
|
+
declare const PeppolTaxTotalsBase_base: OpaqueSchema<PeppolTaxTotalsBase, Schema.Struct<{
|
|
1257
|
+
/**
|
|
1258
|
+
* @example
|
|
1259
|
+
* 200;
|
|
1260
|
+
*
|
|
1261
|
+
* @name cbc:TaxAmount (+ @currencyID)
|
|
1262
|
+
*/
|
|
1263
|
+
readonly taxAmount: typeof PeppolAmount;
|
|
1264
|
+
/**
|
|
1265
|
+
* @name cac:TaxSubtotal (0..n)
|
|
1266
|
+
*/
|
|
1267
|
+
readonly taxSubtotals: Schema.optional<Schema.$Array<typeof PeppolTaxSubTotal>>;
|
|
1268
|
+
}>>;
|
|
1269
|
+
/**
|
|
1270
|
+
* @summary TAX TOTAL
|
|
1271
|
+
*
|
|
1272
|
+
* @name cac:TaxTotal (1..2)
|
|
1273
|
+
*/
|
|
1274
|
+
declare class PeppolTaxTotalsBase extends PeppolTaxTotalsBase_base {}
|
|
1275
|
+
type PeppolTaxTotal = PeppolTaxTotalsBase;
|
|
1276
|
+
//#endregion
|
|
1277
|
+
//#region src/schemas/peppol-billing-base-schema.d.ts
|
|
1278
|
+
declare const PeppolContractDocumentReference_base: OpaqueSchema<PeppolContractDocumentReference, Schema.Struct<{
|
|
1279
|
+
/**
|
|
1280
|
+
* @description An identifier of a referenced contract.
|
|
1281
|
+
*
|
|
1282
|
+
* @example
|
|
1283
|
+
* `123Contractref`;
|
|
1284
|
+
*
|
|
1285
|
+
* @summary Contract reference
|
|
1286
|
+
*
|
|
1287
|
+
* @name `cbc:ID`
|
|
1288
|
+
*/
|
|
1289
|
+
readonly id: Schema.String;
|
|
1290
|
+
}>>;
|
|
1291
|
+
declare class PeppolContractDocumentReference extends PeppolContractDocumentReference_base {}
|
|
1292
|
+
declare const PeppolOriginatorDocumentReference_base: OpaqueSchema<PeppolOriginatorDocumentReference, Schema.Struct<{
|
|
1293
|
+
/**
|
|
1294
|
+
* @description The identification of the call for tender or lot the invoice relates to.
|
|
1295
|
+
*
|
|
1296
|
+
* @example
|
|
1297
|
+
* `PPID-123`;
|
|
1298
|
+
*
|
|
1299
|
+
* @summary Tender or lot reference
|
|
1300
|
+
*
|
|
1301
|
+
* @name `cbc:ID`
|
|
1302
|
+
*/
|
|
1303
|
+
readonly id: Schema.String;
|
|
1304
|
+
}>>;
|
|
1305
|
+
declare class PeppolOriginatorDocumentReference extends PeppolOriginatorDocumentReference_base {}
|
|
1306
|
+
declare const PeppolReceiptDocumentReference_base: OpaqueSchema<PeppolReceiptDocumentReference, Schema.Struct<{
|
|
1307
|
+
/**
|
|
1308
|
+
* @description An identifier of a referenced receiving advice.
|
|
1309
|
+
*
|
|
1310
|
+
* @example
|
|
1311
|
+
* `rec98`;
|
|
1312
|
+
*
|
|
1313
|
+
* @summary Receiving advice reference
|
|
1314
|
+
*
|
|
1315
|
+
* @name `cbc:ID`
|
|
1316
|
+
*/
|
|
1317
|
+
readonly id: Schema.String;
|
|
1318
|
+
}>>;
|
|
1319
|
+
declare class PeppolReceiptDocumentReference extends PeppolReceiptDocumentReference_base {}
|
|
1320
|
+
declare const PeppolDespatchDocumentReference_base: OpaqueSchema<PeppolDespatchDocumentReference, Schema.Struct<{
|
|
1321
|
+
/**
|
|
1322
|
+
* @description An identifier of a referenced despatch advice.
|
|
1323
|
+
*
|
|
1324
|
+
* @example
|
|
1325
|
+
* `desp98`;
|
|
1326
|
+
*
|
|
1327
|
+
* @summary Despatch advice reference
|
|
1328
|
+
*
|
|
1329
|
+
* @name `cbc:ID`
|
|
1330
|
+
*/
|
|
1331
|
+
readonly id: Schema.String;
|
|
1332
|
+
}>>;
|
|
1333
|
+
declare class PeppolDespatchDocumentReference extends PeppolDespatchDocumentReference_base {}
|
|
1334
|
+
declare const PeppolBillingBase_base: OpaqueSchema<PeppolBillingBase, Schema.Struct<{
|
|
1335
|
+
/**
|
|
1336
|
+
* @description An identification of the specification containing the total set of rules regarding semantic content, cardinalities, and business rules to which
|
|
1337
|
+
* the data contained in the intance document conforms.
|
|
1338
|
+
*
|
|
1339
|
+
* @default `urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0`
|
|
1340
|
+
*
|
|
1341
|
+
* @summary Specification identifier
|
|
1342
|
+
*
|
|
1343
|
+
* @cardinality 1..1
|
|
1344
|
+
*
|
|
1345
|
+
* @name `cbc:CustomizationID`
|
|
1346
|
+
*/
|
|
1347
|
+
readonly customizationId: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
1348
|
+
/**
|
|
1349
|
+
* @description Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.
|
|
1350
|
+
*
|
|
1351
|
+
* @default `urn:fdc:peppol.eu:2017:poacc:billing:01:1.0`
|
|
1352
|
+
*
|
|
1353
|
+
* @summary Business process type
|
|
1354
|
+
*
|
|
1355
|
+
* @name `cbc:ProfileID`
|
|
1356
|
+
*/
|
|
1357
|
+
readonly profileId: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
1358
|
+
/**
|
|
1359
|
+
* @description A using identification of the Invoice. The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify
|
|
1360
|
+
* the Invoice within the business context, time-frame, operating systems and records of the Seller. No identification scheme is to be used.
|
|
1361
|
+
*
|
|
1362
|
+
* @example
|
|
1363
|
+
* 33445566;
|
|
1364
|
+
*
|
|
1365
|
+
* @summary Invoice number
|
|
1366
|
+
*
|
|
1367
|
+
* @name `cbc:ID`
|
|
1368
|
+
*/
|
|
1369
|
+
readonly id: Schema.String;
|
|
1370
|
+
/**
|
|
1371
|
+
* @description The date when the invoice was issued.
|
|
1372
|
+
*
|
|
1373
|
+
* @example
|
|
1374
|
+
* `2017-11-01`;
|
|
1375
|
+
*
|
|
1376
|
+
* @summary Invoice issue date
|
|
1377
|
+
*
|
|
1378
|
+
* @format `YYYY-MM-DD`
|
|
1379
|
+
*
|
|
1380
|
+
* @name `cbc:IssueDate`
|
|
1381
|
+
*/
|
|
1382
|
+
readonly issueDate: typeof PeppolIsoDateString;
|
|
1383
|
+
/**
|
|
1384
|
+
* @description Invoice note A textual note that gives unstructured information that is relevant to the Credit Note as a whole.
|
|
1385
|
+
*
|
|
1386
|
+
* @example
|
|
1387
|
+
* Please note our new phone number 33 44 55 66
|
|
1388
|
+
*
|
|
1389
|
+
* @name `cbc:Note`
|
|
1390
|
+
*/
|
|
1391
|
+
readonly note: Schema.optional<Schema.String>;
|
|
1392
|
+
/**
|
|
1393
|
+
* @description The date when the VAT becomes accountable for the Seller and for the Buyer in so far as that date can be determined and differs from the date
|
|
1394
|
+
* of issue of the invoice, according to the VAT directive.This element is required if the Value added tax point date is different from the
|
|
1395
|
+
* Invoice issue date.
|
|
1396
|
+
*
|
|
1397
|
+
* @example
|
|
1398
|
+
* 2017 - 11 - 01;
|
|
1399
|
+
*
|
|
1400
|
+
* @summary Value added tax point date
|
|
1401
|
+
*
|
|
1402
|
+
* @name `cbc:TaxPointDate`
|
|
1403
|
+
*/
|
|
1404
|
+
readonly taxPointDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
1405
|
+
/**
|
|
1406
|
+
* @description The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency. Only one currency shall be used in
|
|
1407
|
+
* the Invoice, except for the VAT accounting currency code (BT-6) and the invoice total VAT amount in accounting currency (BT-111).
|
|
1408
|
+
*
|
|
1409
|
+
* @example
|
|
1410
|
+
* EUR;
|
|
1411
|
+
*
|
|
1412
|
+
* @summary Invoice currency code
|
|
1413
|
+
*
|
|
1414
|
+
* @name `cbc:DocumentCurrencyCode`
|
|
1415
|
+
*/
|
|
1416
|
+
readonly documentCurrencyCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCurrencyCode">;
|
|
1417
|
+
/**
|
|
1418
|
+
* @description The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller. Shall be used in combination
|
|
1419
|
+
* with the Invoice total VAT amount in accounting currency (BT-111), when the VAT accounting currency code differs from the Invoice currency
|
|
1420
|
+
* code.
|
|
1421
|
+
*
|
|
1422
|
+
* @example
|
|
1423
|
+
* SEK;
|
|
1424
|
+
*
|
|
1425
|
+
* @summary VAT accounting currency code
|
|
1426
|
+
*
|
|
1427
|
+
* @name `cbc:TaxCurrencyCode`
|
|
1428
|
+
*/
|
|
1429
|
+
readonly taxCurrencyCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCurrencyCode">>;
|
|
1430
|
+
/**
|
|
1431
|
+
* @description A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
|
|
1432
|
+
*
|
|
1433
|
+
* @example
|
|
1434
|
+
* `4217:2323:2323`;
|
|
1435
|
+
*
|
|
1436
|
+
* @summary Buyer accounting reference
|
|
1437
|
+
*
|
|
1438
|
+
* @name `cbc:AccountingCost`
|
|
1439
|
+
*/
|
|
1440
|
+
readonly accountingCost: Schema.optional<Schema.String>;
|
|
1441
|
+
/**
|
|
1442
|
+
* @description An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference
|
|
1443
|
+
* (BT-13).
|
|
1444
|
+
*
|
|
1445
|
+
* @example
|
|
1446
|
+
* `abs1234`;
|
|
1447
|
+
*
|
|
1448
|
+
* @summary Buyer reference
|
|
1449
|
+
*
|
|
1450
|
+
* @name `cbc:BuyerReference`
|
|
1451
|
+
*/
|
|
1452
|
+
readonly buyerReference: Schema.optional<Schema.String>;
|
|
1453
|
+
/**
|
|
1454
|
+
* @description A group of business terms providing information on the invoice period. Also called delivery period. If the group is used, the invoiceing period
|
|
1455
|
+
* start date and/or end date must be used.
|
|
1456
|
+
*
|
|
1457
|
+
* @summary DELIVERY OR INVOICE PERIOD
|
|
1458
|
+
*
|
|
1459
|
+
* @name `cac:InvoicePeriod`
|
|
1460
|
+
*/
|
|
1461
|
+
readonly invoicePeriod: Schema.optional<typeof PeppolInvoicePeriod>;
|
|
1462
|
+
/**
|
|
1463
|
+
* @summary ORDER AND SALES ORDER REFERENCE
|
|
1464
|
+
*
|
|
1465
|
+
* @name `cac:OrderReference`
|
|
1466
|
+
*/
|
|
1467
|
+
readonly orderReference: Schema.optional<typeof PeppolOrderReference>;
|
|
1468
|
+
/**
|
|
1469
|
+
* @summary PRECEDING INVOICE REFERENCE (0..n)
|
|
1470
|
+
*
|
|
1471
|
+
* @name `cac:BillingReference`
|
|
1472
|
+
*/
|
|
1473
|
+
readonly billingReferences: Schema.optional<Schema.$Array<typeof PeppolBillingReference>>;
|
|
1474
|
+
/**
|
|
1475
|
+
* @summary DESPATCH ADVICE REFERENCE
|
|
1476
|
+
*
|
|
1477
|
+
* @name `cac:DespatchDocumentReference`
|
|
1478
|
+
*/
|
|
1479
|
+
readonly despatchDocumentReference: Schema.optional<typeof PeppolDespatchDocumentReference>;
|
|
1480
|
+
/**
|
|
1481
|
+
* @summary RECEIPT ADVICE REFERENCE
|
|
1482
|
+
*
|
|
1483
|
+
* @name `cac:ReceiptDocumentReference`
|
|
1484
|
+
*/
|
|
1485
|
+
readonly receiptDocumentReference: Schema.optional<typeof PeppolReceiptDocumentReference>;
|
|
1486
|
+
/**
|
|
1487
|
+
* @summary TENDER OR LOT REFERENCE
|
|
1488
|
+
*
|
|
1489
|
+
* @name `cac:OriginatorDocumentReference`
|
|
1490
|
+
*/
|
|
1491
|
+
readonly originatorDocumentReference: Schema.optional<typeof PeppolOriginatorDocumentReference>;
|
|
1492
|
+
/**
|
|
1493
|
+
* @summary CONTRACT REFERENCE
|
|
1494
|
+
*
|
|
1495
|
+
* @name `cac:ContractDocumentReference`
|
|
1496
|
+
*/
|
|
1497
|
+
readonly contractDocumentReference: Schema.optional<typeof PeppolContractDocumentReference>;
|
|
1498
|
+
/**
|
|
1499
|
+
* @description A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. The
|
|
1500
|
+
* additional supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external
|
|
1501
|
+
* document (referenced by a URL) or as an embedded document, Base64 encoded (such as a time report).
|
|
1502
|
+
*
|
|
1503
|
+
* @summary ADDITIONAL SUPPORTING DOCUMENTS
|
|
1504
|
+
*
|
|
1505
|
+
* @name `cac:AdditionalDocumentReference`
|
|
1506
|
+
*/
|
|
1507
|
+
readonly additionalDocumentReferences: Schema.optional<Schema.$Array<typeof PeppolAdditionalDocumentReference>>;
|
|
1508
|
+
/**
|
|
1509
|
+
* @description A group of business terms providing information about the seller.
|
|
1510
|
+
*
|
|
1511
|
+
* @summary SELLER
|
|
1512
|
+
*
|
|
1513
|
+
* @name `cac:AccountingSupplierParty`
|
|
1514
|
+
*/
|
|
1515
|
+
readonly accountingSupplierParty: typeof PeppolPartySchema;
|
|
1516
|
+
/**
|
|
1517
|
+
* @description A group of business terms providing information about the Buyer.
|
|
1518
|
+
*
|
|
1519
|
+
* @summary BUYER
|
|
1520
|
+
*
|
|
1521
|
+
* @name `cac:AccountingCustomerParty`
|
|
1522
|
+
*/
|
|
1523
|
+
readonly accountingCustomerParty: typeof PeppolPartySchema;
|
|
1524
|
+
/**
|
|
1525
|
+
* @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
|
|
1526
|
+
* different from the seller.
|
|
1527
|
+
*
|
|
1528
|
+
* @summary PAYEE
|
|
1529
|
+
*
|
|
1530
|
+
* @name cac:PayeeParty
|
|
1531
|
+
*/
|
|
1532
|
+
readonly payeeParty: Schema.optional<typeof PeppolPayeeParty>;
|
|
1533
|
+
/**
|
|
1534
|
+
* @description SELLER TAX REPRESENTATIVE PARTY.
|
|
1535
|
+
*
|
|
1536
|
+
* @name cac:TaxRepresentativeParty
|
|
1537
|
+
*/
|
|
1538
|
+
readonly taxRepresentativeParty: Schema.optional<typeof PeppolTaxRepresentative>;
|
|
1539
|
+
/**
|
|
1540
|
+
* @description DELIVERY INFORMATION.
|
|
1541
|
+
*
|
|
1542
|
+
* @name cac:Delivery
|
|
1543
|
+
*/
|
|
1544
|
+
readonly delivery: Schema.optional<typeof PeppolDelivery>;
|
|
1545
|
+
/**
|
|
1546
|
+
* @summary PAYMENT INSTRUCTIONS
|
|
1547
|
+
* @summary A group of business terms providing information about the payment.
|
|
1548
|
+
*
|
|
1549
|
+
* @name cac:PaymentMeans
|
|
1550
|
+
*/
|
|
1551
|
+
readonly paymentMeans: Schema.optional<Schema.$Array<typeof PeppolPaymentMeans>>;
|
|
1552
|
+
/**
|
|
1553
|
+
* @example
|
|
1554
|
+
* Net within 30 days
|
|
1555
|
+
*
|
|
1556
|
+
* @summary PAYMENT TERMS
|
|
1557
|
+
*
|
|
1558
|
+
* @name cac:PaymentTerms
|
|
1559
|
+
*/
|
|
1560
|
+
readonly paymentTerms: Schema.optional<typeof PeppolPaymentTerms>;
|
|
1561
|
+
/**
|
|
1562
|
+
* @description A group of business terms providing information about allowances applicable to the Invoice as a whole. A group of business terms providing
|
|
1563
|
+
* information about charges and taxes other than VAT, applicable to the Invoice as a whole.
|
|
1564
|
+
*
|
|
1565
|
+
* @summary DOCUMENT LEVEL ALLOWANCES AND CHARGES
|
|
1566
|
+
*
|
|
1567
|
+
* @name cac:AllowanceCharge
|
|
1568
|
+
*/
|
|
1569
|
+
readonly allowanceCharges: Schema.optional<Schema.$Array<Schema.Union<readonly [typeof PeppolAllowance, typeof PeppolCharge]>>>;
|
|
1570
|
+
/**
|
|
1571
|
+
* @description When tax currency code is provided, two instances of the tax total must be present, but only one with tax subtotal.
|
|
1572
|
+
*
|
|
1573
|
+
* @summary TAX TOTAL
|
|
1574
|
+
*
|
|
1575
|
+
* @name cac:TaxTotal
|
|
1576
|
+
*/
|
|
1577
|
+
readonly taxTotals: Schema.$Array<typeof PeppolTaxTotalsBase>;
|
|
1578
|
+
/**
|
|
1579
|
+
* @summary DOCUMENT TOTALS
|
|
1580
|
+
*
|
|
1581
|
+
* @name cac:LegalMonetaryTotal
|
|
1582
|
+
*/
|
|
1583
|
+
readonly legalMonetaryTotal: typeof PeppolLegalMonetaryTotal;
|
|
1584
|
+
}>>;
|
|
1585
|
+
/**
|
|
1586
|
+
* @description Base schema for a billing document.
|
|
1587
|
+
*
|
|
1588
|
+
* @see {@link creditNoteSchema} - the credit note schema
|
|
1589
|
+
* @see {@link invoiceSchema} - the invoice schema
|
|
1590
|
+
*/
|
|
1591
|
+
declare class PeppolBillingBase extends PeppolBillingBase_base {}
|
|
1592
|
+
//#endregion
|
|
1593
|
+
//#region src/schemas/fields/peppol-line-allowance-charge-schema.d.ts
|
|
1594
|
+
declare const BaseLineAllowanceCharge_base: OpaqueSchema<BaseLineAllowanceCharge, Schema.Struct<{
|
|
1595
|
+
readonly amount: typeof PeppolAmount;
|
|
1596
|
+
readonly baseAmount: Schema.optional<typeof PeppolAmount>;
|
|
1597
|
+
readonly chargeIndicator: Schema.Boolean;
|
|
1598
|
+
readonly allowanceChargeReason: Schema.optional<Schema.String>;
|
|
1599
|
+
/**
|
|
1600
|
+
* @example
|
|
1601
|
+
* 20;
|
|
1602
|
+
*
|
|
1603
|
+
* @name cbc:MultiplierFactorNumeric
|
|
1604
|
+
*/
|
|
1605
|
+
readonly multiplierFactorNumeric: Schema.optional<Schema.Finite>;
|
|
1606
|
+
}>>;
|
|
1607
|
+
declare class BaseLineAllowanceCharge extends BaseLineAllowanceCharge_base {}
|
|
1608
|
+
declare const PeppolLineAllowance_base: OpaqueSchema<PeppolLineAllowance, Schema.Struct<{
|
|
1609
|
+
readonly amount: typeof PeppolAmount;
|
|
1610
|
+
readonly baseAmount: Schema.optional<typeof PeppolAmount>;
|
|
1611
|
+
readonly allowanceChargeReason: Schema.optional<Schema.String>;
|
|
1612
|
+
/**
|
|
1613
|
+
* @example
|
|
1614
|
+
* 20;
|
|
1615
|
+
*
|
|
1616
|
+
* @name cbc:MultiplierFactorNumeric
|
|
1617
|
+
*/
|
|
1618
|
+
readonly multiplierFactorNumeric: Schema.optional<Schema.Finite>;
|
|
1619
|
+
/**
|
|
1620
|
+
* @name cbc:AllowanceChargeReasonCode
|
|
1621
|
+
*/
|
|
1622
|
+
readonly allowanceChargeReasonCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolAllowanceChargeReasonCode">>;
|
|
1623
|
+
/**
|
|
1624
|
+
* @name cbc:ChargeIndicator
|
|
1625
|
+
*
|
|
1626
|
+
* @value `false`
|
|
1627
|
+
*/
|
|
1628
|
+
readonly chargeIndicator: Schema.Literal<false>;
|
|
1629
|
+
}>>;
|
|
1630
|
+
declare class PeppolLineAllowance extends PeppolLineAllowance_base {}
|
|
1631
|
+
declare const PeppolLineCharge_base: OpaqueSchema<PeppolLineCharge, Schema.Struct<{
|
|
1632
|
+
readonly amount: typeof PeppolAmount;
|
|
1633
|
+
readonly baseAmount: Schema.optional<typeof PeppolAmount>;
|
|
1634
|
+
readonly allowanceChargeReason: Schema.optional<Schema.String>;
|
|
1635
|
+
/**
|
|
1636
|
+
* @example
|
|
1637
|
+
* 20;
|
|
1638
|
+
*
|
|
1639
|
+
* @name cbc:MultiplierFactorNumeric
|
|
1640
|
+
*/
|
|
1641
|
+
readonly multiplierFactorNumeric: Schema.optional<Schema.Finite>;
|
|
1642
|
+
/**
|
|
1643
|
+
* @name cbc:AllowanceChargeReasonCode
|
|
1644
|
+
*/
|
|
1645
|
+
readonly allowanceChargeReasonCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolChargeReasonCode">>;
|
|
1646
|
+
/**
|
|
1647
|
+
* @name cbc:ChargeIndicator
|
|
1648
|
+
*
|
|
1649
|
+
* @value `true`
|
|
1650
|
+
*/
|
|
1651
|
+
readonly chargeIndicator: Schema.Literal<true>;
|
|
1652
|
+
}>>;
|
|
1653
|
+
declare class PeppolLineCharge extends PeppolLineCharge_base {}
|
|
1654
|
+
declare const peppolLineAllowanceChargeSchema: Schema.Union<readonly [typeof PeppolLineAllowance, typeof PeppolLineCharge]>;
|
|
1655
|
+
type PeppolLineAllowanceCharge = typeof peppolLineAllowanceChargeSchema.Type;
|
|
1656
|
+
type PeppolLineAllowanceChargeEncoded = typeof peppolLineAllowanceChargeSchema.Encoded;
|
|
1657
|
+
//#endregion
|
|
1658
|
+
//#region src/schemas/fields/peppol-invoice-line-period-schema.d.ts
|
|
1659
|
+
declare const PeppolInvoiceLinePeriod_base: OpaqueSchema<PeppolInvoiceLinePeriod, Schema.Struct<{
|
|
1660
|
+
/**
|
|
1661
|
+
* @description The date when the Invoice period for this Invoice line ends. Format ="YYYY-MM-DD"
|
|
1662
|
+
*
|
|
1663
|
+
* @example
|
|
1664
|
+
* `2017-10-31`;
|
|
1665
|
+
*
|
|
1666
|
+
* @summary Invoice line period end date
|
|
1667
|
+
*
|
|
1668
|
+
* @format "YYYY-MM-DD"
|
|
1669
|
+
*
|
|
1670
|
+
* @name `cbc:EndDate`
|
|
1671
|
+
*/
|
|
1672
|
+
readonly endDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
1673
|
+
/**
|
|
1674
|
+
* @description The date when the Invoice period for this Invoice line starts.
|
|
1675
|
+
*
|
|
1676
|
+
* @example
|
|
1677
|
+
* `2017-10-01`;
|
|
1678
|
+
*
|
|
1679
|
+
* @summary Invoice line period start date
|
|
1680
|
+
*
|
|
1681
|
+
* @format "YYYY-MM-DD"
|
|
1682
|
+
*
|
|
1683
|
+
* @name `cbc:StartDate`
|
|
1684
|
+
*/
|
|
1685
|
+
readonly startDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
1686
|
+
}>>;
|
|
1687
|
+
declare class PeppolInvoiceLinePeriod extends PeppolInvoiceLinePeriod_base {}
|
|
1688
|
+
//#endregion
|
|
1689
|
+
//#region src/schemas/fields/peppol-item-classification-schema.d.ts
|
|
1690
|
+
declare const PeppolItemClassification_base: OpaqueSchema<PeppolItemClassification, Schema.Struct<{
|
|
1691
|
+
/**
|
|
1692
|
+
* @description A code for classifying the item by its type or nature.
|
|
1693
|
+
*
|
|
1694
|
+
* @summary Item classification identifier
|
|
1695
|
+
*
|
|
1696
|
+
* @name `#text`
|
|
1697
|
+
*/
|
|
1698
|
+
readonly id: Schema.String;
|
|
1699
|
+
/**
|
|
1700
|
+
* @description The identification scheme identifier of the item classification identifier.
|
|
1701
|
+
*
|
|
1702
|
+
* @summary Item classification identifier identification scheme identifier
|
|
1703
|
+
*
|
|
1704
|
+
* @name `@listID`
|
|
1705
|
+
*/
|
|
1706
|
+
readonly listId: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolItemClassificationCode">;
|
|
1707
|
+
/**
|
|
1708
|
+
* @description The identification scheme version identifier of the Item classification identifier.
|
|
1709
|
+
*
|
|
1710
|
+
* @remarks
|
|
1711
|
+
* Only used with danish.
|
|
1712
|
+
*
|
|
1713
|
+
* @summary Item classification identifier version identification scheme identifier
|
|
1714
|
+
*
|
|
1715
|
+
* @name `@listVersionID`
|
|
1716
|
+
*/
|
|
1717
|
+
readonly listVersionId: Schema.optional<Schema.String>;
|
|
1718
|
+
}>>;
|
|
1719
|
+
/**
|
|
1720
|
+
* @description A code for classifying the item by its type or nature.
|
|
1721
|
+
*
|
|
1722
|
+
* @example
|
|
1723
|
+
* `9873242`;
|
|
1724
|
+
*
|
|
1725
|
+
* @summary Item classification identifier
|
|
1726
|
+
*
|
|
1727
|
+
* @name `cbc:ItemClassificationCode`
|
|
1728
|
+
*/
|
|
1729
|
+
declare class PeppolItemClassification extends PeppolItemClassification_base {}
|
|
1730
|
+
//#endregion
|
|
1731
|
+
//#region src/schemas/fields/peppol-line-item-schema.d.ts
|
|
1732
|
+
declare const PeppolAdditionalItemProperties_base: OpaqueSchema<PeppolAdditionalItemProperties, Schema.Struct<{
|
|
1733
|
+
/**
|
|
1734
|
+
* @description The name of the attribute or property of the item.
|
|
1735
|
+
*
|
|
1736
|
+
* @summary Item attribute name
|
|
1737
|
+
*
|
|
1738
|
+
* @name cbc:Name
|
|
1739
|
+
*/
|
|
1740
|
+
readonly name: Schema.String;
|
|
1741
|
+
/**
|
|
1742
|
+
* @description The value of the attribute or property of the item.
|
|
1743
|
+
*
|
|
1744
|
+
* @summary Item attribute value
|
|
1745
|
+
*
|
|
1746
|
+
* @name cbc:Value
|
|
1747
|
+
*/
|
|
1748
|
+
readonly value: Schema.String;
|
|
1749
|
+
}>>;
|
|
1750
|
+
declare class PeppolAdditionalItemProperties extends PeppolAdditionalItemProperties_base {}
|
|
1751
|
+
declare const PeppolCommodityClassifications_base: OpaqueSchema<PeppolCommodityClassifications, Schema.Struct<{
|
|
1752
|
+
/**
|
|
1753
|
+
* @description A code for classifying the item by its type or nature.
|
|
1754
|
+
*
|
|
1755
|
+
* @example
|
|
1756
|
+
* `9873242`;
|
|
1757
|
+
*
|
|
1758
|
+
* @summary Item classification identifier
|
|
1759
|
+
*
|
|
1760
|
+
* @name `cbc:ItemClassificationCode`
|
|
1761
|
+
*/
|
|
1762
|
+
readonly itemClassification: typeof PeppolItemClassification;
|
|
1763
|
+
}>>;
|
|
1764
|
+
declare class PeppolCommodityClassifications extends PeppolCommodityClassifications_base {}
|
|
1765
|
+
declare const PeppolOriginCountryCode_base: OpaqueSchema<PeppolOriginCountryCode, Schema.Struct<{
|
|
1766
|
+
/**
|
|
1767
|
+
* @description The code identifying the country from which the item originates.
|
|
1768
|
+
*
|
|
1769
|
+
* @summary Item country of origin
|
|
1770
|
+
*
|
|
1771
|
+
* @name `cbc:IdentificationCode`
|
|
1772
|
+
*/
|
|
1773
|
+
readonly identificationCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCountryCode">;
|
|
1774
|
+
}>>;
|
|
1775
|
+
declare class PeppolOriginCountryCode extends PeppolOriginCountryCode_base {}
|
|
1776
|
+
declare const PeppolStandardItemIdentification_base: OpaqueSchema<PeppolStandardItemIdentification, Schema.Struct<{
|
|
1777
|
+
/**
|
|
1778
|
+
* @description An item identifier based on a registered scheme.
|
|
1779
|
+
*
|
|
1780
|
+
* @summary Item standard identifier
|
|
1781
|
+
*
|
|
1782
|
+
* @name `cbc:ID`
|
|
1783
|
+
*/
|
|
1784
|
+
readonly id: Schema.Struct<{
|
|
1785
|
+
readonly id: Schema.String;
|
|
1786
|
+
readonly schemeId: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolIcdCode">;
|
|
1787
|
+
}>;
|
|
1788
|
+
}>>;
|
|
1789
|
+
declare class PeppolStandardItemIdentification extends PeppolStandardItemIdentification_base {}
|
|
1790
|
+
declare const PeppolSellersItemIdentification_base: OpaqueSchema<PeppolSellersItemIdentification, Schema.Struct<{
|
|
1791
|
+
/**
|
|
1792
|
+
* @description An identifier, assigned by the Seller, for the item.
|
|
1793
|
+
*
|
|
1794
|
+
* @example
|
|
1795
|
+
* `987323`;
|
|
1796
|
+
*
|
|
1797
|
+
* @summary Item Seller's identifier
|
|
1798
|
+
*
|
|
1799
|
+
* @name `cbc:ID`
|
|
1800
|
+
*/
|
|
1801
|
+
readonly id: Schema.String;
|
|
1802
|
+
}>>;
|
|
1803
|
+
declare class PeppolSellersItemIdentification extends PeppolSellersItemIdentification_base {}
|
|
1804
|
+
declare const PeppolBuyersItemIdentification_base: OpaqueSchema<PeppolBuyersItemIdentification, Schema.Struct<{
|
|
1805
|
+
/**
|
|
1806
|
+
* @description An identifier, assigned by the Buyer, for the item.
|
|
1807
|
+
*
|
|
1808
|
+
* @example
|
|
1809
|
+
* `12345`;
|
|
1810
|
+
*
|
|
1811
|
+
* @summary Item Buyer's identifier
|
|
1812
|
+
*
|
|
1813
|
+
* @name `cbc:ID`
|
|
1814
|
+
*/
|
|
1815
|
+
readonly id: Schema.String;
|
|
1816
|
+
}>>;
|
|
1817
|
+
declare class PeppolBuyersItemIdentification extends PeppolBuyersItemIdentification_base {}
|
|
1818
|
+
declare const PeppolLineItem_base: OpaqueSchema<PeppolLineItem, Schema.Struct<{
|
|
1819
|
+
/**
|
|
1820
|
+
* @description A description for an item. The item description allows for descibing the item and its features in more detail than the item name.
|
|
1821
|
+
*
|
|
1822
|
+
* @summary Item description
|
|
1823
|
+
*
|
|
1824
|
+
* @name cbc:Description
|
|
1825
|
+
*/
|
|
1826
|
+
readonly description: Schema.optional<Schema.String>;
|
|
1827
|
+
/**
|
|
1828
|
+
* @description A name for an item.
|
|
1829
|
+
*
|
|
1830
|
+
* @summary Item name
|
|
1831
|
+
*
|
|
1832
|
+
* @name cbc:Name
|
|
1833
|
+
*/
|
|
1834
|
+
readonly name: Schema.String;
|
|
1835
|
+
/**
|
|
1836
|
+
* @summary BUYERS ITEM IDENTIFICATION
|
|
1837
|
+
*
|
|
1838
|
+
* @name cac:BuyersItemIdentification
|
|
1839
|
+
*/
|
|
1840
|
+
readonly buyersItemIdentification: Schema.optional<typeof PeppolBuyersItemIdentification>;
|
|
1841
|
+
/**
|
|
1842
|
+
* @summary Sellers item identification
|
|
1843
|
+
*
|
|
1844
|
+
* @name cac:SellersItemIdentification
|
|
1845
|
+
*/
|
|
1846
|
+
readonly sellersItemIdentification: Schema.optional<typeof PeppolSellersItemIdentification>;
|
|
1847
|
+
/**
|
|
1848
|
+
* @summary Standard item identification
|
|
1849
|
+
*
|
|
1850
|
+
* @name cac:StandardItemIdentification
|
|
1851
|
+
*/
|
|
1852
|
+
readonly standardItemIdentification: Schema.optional<typeof PeppolStandardItemIdentification>;
|
|
1853
|
+
/**
|
|
1854
|
+
* @summary ORIGIN COUNTRY
|
|
1855
|
+
*
|
|
1856
|
+
* @name `cac:OriginCountry`
|
|
1857
|
+
*/
|
|
1858
|
+
readonly originCountryCode: Schema.optional<typeof PeppolOriginCountryCode>;
|
|
1859
|
+
/**
|
|
1860
|
+
* @summary COMMODITY CLASSIFICATION
|
|
1861
|
+
*
|
|
1862
|
+
* @name cac:CommodityClassification (0..n)
|
|
1863
|
+
*/
|
|
1864
|
+
readonly commodityClassifications: Schema.optional<Schema.$Array<typeof PeppolCommodityClassifications>>;
|
|
1865
|
+
/**
|
|
1866
|
+
* @description A group of business terms providing information about the VAT applicable for the goods and services invoiced on the Invoice line.
|
|
1867
|
+
*
|
|
1868
|
+
* @summary LINE VAT INFORMATION
|
|
1869
|
+
*
|
|
1870
|
+
* @name cac:ClassifiedTaxCategory
|
|
1871
|
+
*/
|
|
1872
|
+
readonly classifiedTaxCategory: typeof PeppolTaxCategory;
|
|
1873
|
+
/**
|
|
1874
|
+
* @description A group of business terms providing information about properties of the goods and services invoiced.
|
|
1875
|
+
*
|
|
1876
|
+
* @summary ITEM ATTRIBUTES
|
|
1877
|
+
*
|
|
1878
|
+
* @name cac:AdditionalItemProperty
|
|
1879
|
+
*/
|
|
1880
|
+
readonly additionalItemProperties: Schema.optional<Schema.$Array<typeof PeppolAdditionalItemProperties>>;
|
|
1881
|
+
}>>;
|
|
1882
|
+
/**
|
|
1883
|
+
* @summary Item details on invoice/credit-note line
|
|
1884
|
+
*
|
|
1885
|
+
* @name cac:Item
|
|
1886
|
+
*/
|
|
1887
|
+
declare class PeppolLineItem extends PeppolLineItem_base {}
|
|
1888
|
+
type PeppolItem = PeppolLineItem;
|
|
1889
|
+
//#endregion
|
|
1890
|
+
//#region src/schemas/fields/peppol-line-price-allowance-charge-schema.d.ts
|
|
1891
|
+
declare const PriceAllowanceCharge_base: OpaqueSchema<PriceAllowanceCharge, Schema.Struct<{
|
|
1892
|
+
/**
|
|
1893
|
+
* @example
|
|
1894
|
+
* 200;
|
|
1895
|
+
*
|
|
1896
|
+
* @name cbc:Amount (+ @currencyID)
|
|
1897
|
+
*/
|
|
1898
|
+
readonly amount: typeof PeppolAmount;
|
|
1899
|
+
/**
|
|
1900
|
+
* @example
|
|
1901
|
+
* 1000;
|
|
1902
|
+
*
|
|
1903
|
+
* @name cbc:BaseAmount (+ @currencyID)
|
|
1904
|
+
*/
|
|
1905
|
+
readonly baseAmount: Schema.optional<typeof PeppolAmount>;
|
|
1906
|
+
/**
|
|
1907
|
+
* @name cbc:ChargeIndicator
|
|
1908
|
+
*
|
|
1909
|
+
* @value false
|
|
1910
|
+
*/
|
|
1911
|
+
readonly chargeIndicator: Schema.Boolean;
|
|
1912
|
+
}>>;
|
|
1913
|
+
declare class PriceAllowanceCharge extends PriceAllowanceCharge_base {}
|
|
1914
|
+
declare const PeppolLinePriceAllowanceCharge_base: OpaqueSchema<PeppolLinePriceAllowanceCharge, Schema.Struct<{
|
|
1915
|
+
readonly amount: typeof PeppolAmount;
|
|
1916
|
+
readonly baseAmount: Schema.optional<typeof PeppolAmount>;
|
|
1917
|
+
readonly chargeIndicator: Schema.Literal<false>;
|
|
1918
|
+
}>>;
|
|
1919
|
+
declare class PeppolLinePriceAllowanceCharge extends PeppolLinePriceAllowanceCharge_base {}
|
|
1920
|
+
//#endregion
|
|
1921
|
+
//#region src/schemas/fields/peppol-quantity-schema.d.ts
|
|
1922
|
+
declare const PeppolQuantity_base: OpaqueSchema<PeppolQuantity, Schema.Struct<{
|
|
1923
|
+
/**
|
|
1924
|
+
* @name `@unitCode`
|
|
1925
|
+
*/
|
|
1926
|
+
readonly unitCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolQuantityUnitCode">>;
|
|
1927
|
+
/**
|
|
1928
|
+
* @name `#text (value)`
|
|
1929
|
+
*/
|
|
1930
|
+
readonly value: Schema.Finite;
|
|
1931
|
+
}>>;
|
|
1932
|
+
/**
|
|
1933
|
+
* @summary Quantity with optional unit code
|
|
1934
|
+
*
|
|
1935
|
+
* @name `cbc:* (+ @unitCode)`
|
|
1936
|
+
*/
|
|
1937
|
+
declare class PeppolQuantity extends PeppolQuantity_base {}
|
|
1938
|
+
//#endregion
|
|
1939
|
+
//#region src/schemas/fields/peppol-line-price-schema.d.ts
|
|
1940
|
+
declare const PeppolLinePrice_base: OpaqueSchema<PeppolLinePrice, Schema.Struct<{
|
|
1941
|
+
/**
|
|
1942
|
+
* @name cac:AllowanceCharge
|
|
1943
|
+
*
|
|
1944
|
+
* @cardinality 0..1
|
|
1945
|
+
*/
|
|
1946
|
+
readonly allowanceCharge: Schema.optional<typeof PeppolLinePriceAllowanceCharge>;
|
|
1947
|
+
/**
|
|
1948
|
+
* @name cbc:BaseQuantity (+ @unitCode)
|
|
1949
|
+
*
|
|
1950
|
+
* @cardinality 0..1
|
|
1951
|
+
*/
|
|
1952
|
+
readonly baseQuantity: Schema.optional<typeof PeppolQuantity>;
|
|
1953
|
+
/**
|
|
1954
|
+
* @name cbc:PriceAmount (+ @currencyID)
|
|
1955
|
+
*/
|
|
1956
|
+
readonly priceAmount: typeof PeppolAmount;
|
|
1957
|
+
}>>;
|
|
1958
|
+
/**
|
|
1959
|
+
* @summary Price details on invoice line
|
|
1960
|
+
*
|
|
1961
|
+
* @name cac:Price
|
|
1962
|
+
*/
|
|
1963
|
+
declare class PeppolLinePrice extends PeppolLinePrice_base {}
|
|
1964
|
+
//#endregion
|
|
1965
|
+
//#region src/schemas/fields/peppol-base-line-schema.d.ts
|
|
1966
|
+
declare const PeppolOrderLineReference_base: OpaqueSchema<PeppolOrderLineReference, Schema.Struct<{
|
|
1967
|
+
readonly lineId: Schema.String;
|
|
1968
|
+
}>>;
|
|
1969
|
+
declare class PeppolOrderLineReference extends PeppolOrderLineReference_base {}
|
|
1970
|
+
declare const PeppolBaseLine_base: OpaqueSchema<PeppolBaseLine, Schema.Struct<{
|
|
1971
|
+
/**
|
|
1972
|
+
* @description A textual value that specifies where to book the relevant data into the Buyer's financial accounts.
|
|
1973
|
+
*
|
|
1974
|
+
* @example
|
|
1975
|
+
* `1287:65464`;
|
|
1976
|
+
*
|
|
1977
|
+
* @summary Invoice line Buyer accounting reference
|
|
1978
|
+
*
|
|
1979
|
+
* @name cbc:AccountingCost
|
|
1980
|
+
*
|
|
1981
|
+
* @cardinality 0..1
|
|
1982
|
+
*/
|
|
1983
|
+
readonly accountingCost: Schema.optional<Schema.String>;
|
|
1984
|
+
/**
|
|
1985
|
+
* @description A group of business terms providing information about allowances or charges applicable to the individual Invoice line.
|
|
1986
|
+
*
|
|
1987
|
+
* @summary Invoice line allowances or charges
|
|
1988
|
+
*
|
|
1989
|
+
* @name cac:AllowanceCharge
|
|
1990
|
+
*
|
|
1991
|
+
* @cardinality 0..n
|
|
1992
|
+
*/
|
|
1993
|
+
readonly allowanceCharges: Schema.optional<Schema.$Array<Schema.Union<readonly [typeof PeppolLineAllowance, typeof PeppolLineCharge]>>>;
|
|
1994
|
+
/**
|
|
1995
|
+
* @summary Line object identifier
|
|
1996
|
+
*
|
|
1997
|
+
* @name cac:DocumentReference
|
|
1998
|
+
*
|
|
1999
|
+
* @cardinality 0..1
|
|
2000
|
+
*/
|
|
2001
|
+
readonly documentReference: Schema.optional<Schema.$Array<Schema.Struct<{
|
|
2002
|
+
readonly id: Schema.String;
|
|
2003
|
+
readonly schemeId: Schema.optional<Schema.String>;
|
|
2004
|
+
readonly documentTypeCode: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
2005
|
+
}>>>;
|
|
2006
|
+
/**
|
|
2007
|
+
* @description A unique identifier for the individual line within the Invoice.
|
|
2008
|
+
*
|
|
2009
|
+
* @example
|
|
2010
|
+
* 12;
|
|
2011
|
+
*
|
|
2012
|
+
* @summary Invoice line identifier
|
|
2013
|
+
*
|
|
2014
|
+
* @name cbc:ID
|
|
2015
|
+
*
|
|
2016
|
+
* @cardinality 1..1
|
|
2017
|
+
*/
|
|
2018
|
+
readonly id: Schema.String;
|
|
2019
|
+
/**
|
|
2020
|
+
* @description A group of business terms providing information about the period relevant for the Invoice line.
|
|
2021
|
+
*
|
|
2022
|
+
* @summary Invoice line period
|
|
2023
|
+
*
|
|
2024
|
+
* @name cac:InvoicePeriod
|
|
2025
|
+
*
|
|
2026
|
+
* @cardinality 0..1
|
|
2027
|
+
*/
|
|
2028
|
+
readonly invoicePeriod: Schema.optional<typeof PeppolInvoiceLinePeriod>;
|
|
2029
|
+
/**
|
|
2030
|
+
* @description A group of business terms providing information about the goods and services invoiced.
|
|
2031
|
+
*
|
|
2032
|
+
* @summary Item information
|
|
2033
|
+
*
|
|
2034
|
+
* @name cac:Item
|
|
2035
|
+
*
|
|
2036
|
+
* @cardinality 1..1
|
|
2037
|
+
*/
|
|
2038
|
+
readonly item: typeof PeppolLineItem;
|
|
2039
|
+
/**
|
|
2040
|
+
* @description The total amount of the Invoice line. The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other
|
|
2041
|
+
* relevant taxes. Must be rounded to maximum 2 decimals.
|
|
2042
|
+
*
|
|
2043
|
+
* @example
|
|
2044
|
+
* { value: 2145.0, currencyId: "EUR" }
|
|
2045
|
+
*
|
|
2046
|
+
* @summary Invoice line net amount
|
|
2047
|
+
*
|
|
2048
|
+
* @name cbc:LineExtensionAmount (+ @currencyID)
|
|
2049
|
+
*
|
|
2050
|
+
* @cardinality 1..1
|
|
2051
|
+
*/
|
|
2052
|
+
readonly lineExtensionAmount: typeof PeppolAmount;
|
|
2053
|
+
/**
|
|
2054
|
+
* @description A textual note that gives unstructured information that is relevant to the Invoice line.
|
|
2055
|
+
*
|
|
2056
|
+
* @example
|
|
2057
|
+
* New article number 12345
|
|
2058
|
+
*
|
|
2059
|
+
* @summary Invoice line note
|
|
2060
|
+
*
|
|
2061
|
+
* @name cbc:Note
|
|
2062
|
+
*
|
|
2063
|
+
* @cardinality 0..1
|
|
2064
|
+
*/
|
|
2065
|
+
readonly note: Schema.optional<Schema.String>;
|
|
2066
|
+
/**
|
|
2067
|
+
* @summary Order line reference
|
|
2068
|
+
*
|
|
2069
|
+
* @name cac:OrderLineReference
|
|
2070
|
+
*
|
|
2071
|
+
* @cardinality 0..1
|
|
2072
|
+
*/
|
|
2073
|
+
readonly orderLineReference: Schema.optional<typeof PeppolOrderLineReference>;
|
|
2074
|
+
/**
|
|
2075
|
+
* @description A group of business terms providing information about the price applied for the goods and services invoices on the Invoice line.
|
|
2076
|
+
*
|
|
2077
|
+
* @summary Price Details
|
|
2078
|
+
*
|
|
2079
|
+
* @name cac:Price
|
|
2080
|
+
*
|
|
2081
|
+
* @cardinality 1..1
|
|
2082
|
+
*/
|
|
2083
|
+
readonly price: typeof PeppolLinePrice;
|
|
2084
|
+
}>>;
|
|
2085
|
+
/**
|
|
2086
|
+
* @description Base of the invoice line and credit note line schemas.
|
|
2087
|
+
*/
|
|
2088
|
+
declare class PeppolBaseLine extends PeppolBaseLine_base {}
|
|
2089
|
+
//#endregion
|
|
2090
|
+
//#region src/schemas/fields/peppol-invoice-line-schema.d.ts
|
|
2091
|
+
declare const PeppolInvoiceLine_base: OpaqueSchema<PeppolInvoiceLine, Schema.Struct<{
|
|
2092
|
+
readonly accountingCost: Schema.optional<Schema.String>;
|
|
2093
|
+
readonly allowanceCharges: Schema.optional<Schema.$Array<Schema.Union<readonly [typeof PeppolLineAllowance, typeof PeppolLineCharge]>>>;
|
|
2094
|
+
readonly documentReference: Schema.optional<Schema.$Array<Schema.Struct<{
|
|
2095
|
+
readonly id: Schema.String;
|
|
2096
|
+
readonly schemeId: Schema.optional<Schema.String>;
|
|
2097
|
+
readonly documentTypeCode: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
2098
|
+
}>>>;
|
|
2099
|
+
readonly id: Schema.String;
|
|
2100
|
+
readonly invoicePeriod: Schema.optional<typeof PeppolInvoiceLinePeriod>;
|
|
2101
|
+
readonly item: typeof PeppolLineItem;
|
|
2102
|
+
readonly lineExtensionAmount: typeof PeppolAmount;
|
|
2103
|
+
readonly note: Schema.optional<Schema.String>;
|
|
2104
|
+
readonly orderLineReference: Schema.optional<typeof PeppolOrderLineReference>;
|
|
2105
|
+
readonly price: typeof PeppolLinePrice;
|
|
2106
|
+
/**
|
|
2107
|
+
* @description The quantity of items (goods or services) that is charged in the Invoice line.
|
|
2108
|
+
*
|
|
2109
|
+
* @example
|
|
2110
|
+
* { value: 100, unitCode: "C62" }
|
|
2111
|
+
*
|
|
2112
|
+
* @summary Invoiced quantity
|
|
2113
|
+
*
|
|
2114
|
+
* @name cbc:InvoicedQuantity (+ @unitCode)
|
|
2115
|
+
*/
|
|
2116
|
+
readonly invoicedQuantity: Schema.Struct<{
|
|
2117
|
+
readonly value: Schema.Finite;
|
|
2118
|
+
readonly unitCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolQuantityUnitCode">;
|
|
2119
|
+
}>;
|
|
2120
|
+
}>>;
|
|
2121
|
+
/**
|
|
2122
|
+
* @summary Invoice line
|
|
2123
|
+
*
|
|
2124
|
+
* @name cac:InvoiceLine
|
|
2125
|
+
*/
|
|
2126
|
+
declare class PeppolInvoiceLine extends PeppolInvoiceLine_base {}
|
|
2127
|
+
interface PeppolInvoiceLineEncoded extends Schema.Codec.Encoded<typeof PeppolInvoiceLine> {}
|
|
2128
|
+
//#endregion
|
|
2129
|
+
//#region src/schemas/peppol-invoice-schema.d.ts
|
|
2130
|
+
declare const PeppolProjectReference_base: OpaqueSchema<PeppolProjectReference, Schema.Struct<{
|
|
2131
|
+
readonly id: Schema.String;
|
|
2132
|
+
}>>;
|
|
2133
|
+
declare class PeppolProjectReference extends PeppolProjectReference_base {}
|
|
2134
|
+
declare const PeppolInvoice_base: OpaqueSchema<PeppolInvoice, Schema.Struct<{
|
|
2135
|
+
readonly customizationId: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
2136
|
+
readonly profileId: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
2137
|
+
readonly id: Schema.String;
|
|
2138
|
+
readonly issueDate: typeof PeppolIsoDateString;
|
|
2139
|
+
readonly note: Schema.optional<Schema.String>;
|
|
2140
|
+
readonly taxPointDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
2141
|
+
readonly documentCurrencyCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCurrencyCode">;
|
|
2142
|
+
readonly taxCurrencyCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCurrencyCode">>;
|
|
2143
|
+
readonly accountingCost: Schema.optional<Schema.String>;
|
|
2144
|
+
readonly buyerReference: Schema.optional<Schema.String>;
|
|
2145
|
+
readonly invoicePeriod: Schema.optional<typeof PeppolInvoicePeriod>;
|
|
2146
|
+
readonly orderReference: Schema.optional<typeof PeppolOrderReference>;
|
|
2147
|
+
readonly billingReferences: Schema.optional<Schema.$Array<typeof PeppolBillingReference>>;
|
|
2148
|
+
readonly despatchDocumentReference: Schema.optional<typeof PeppolDespatchDocumentReference>;
|
|
2149
|
+
readonly receiptDocumentReference: Schema.optional<typeof PeppolReceiptDocumentReference>;
|
|
2150
|
+
readonly originatorDocumentReference: Schema.optional<typeof PeppolOriginatorDocumentReference>;
|
|
2151
|
+
readonly contractDocumentReference: Schema.optional<typeof PeppolContractDocumentReference>;
|
|
2152
|
+
readonly additionalDocumentReferences: Schema.optional<Schema.$Array<typeof PeppolAdditionalDocumentReference>>;
|
|
2153
|
+
readonly accountingSupplierParty: typeof PeppolPartySchema;
|
|
2154
|
+
readonly accountingCustomerParty: typeof PeppolPartySchema;
|
|
2155
|
+
readonly payeeParty: Schema.optional<typeof PeppolPayeeParty>;
|
|
2156
|
+
readonly taxRepresentativeParty: Schema.optional<typeof PeppolTaxRepresentative>;
|
|
2157
|
+
readonly delivery: Schema.optional<typeof PeppolDelivery>;
|
|
2158
|
+
readonly paymentMeans: Schema.optional<Schema.$Array<typeof PeppolPaymentMeans>>;
|
|
2159
|
+
readonly paymentTerms: Schema.optional<typeof PeppolPaymentTerms>;
|
|
2160
|
+
readonly allowanceCharges: Schema.optional<Schema.$Array<Schema.Union<readonly [typeof PeppolAllowance, typeof PeppolCharge]>>>;
|
|
2161
|
+
readonly taxTotals: Schema.$Array<typeof PeppolTaxTotalsBase>;
|
|
2162
|
+
readonly legalMonetaryTotal: typeof PeppolLegalMonetaryTotal;
|
|
2163
|
+
/**
|
|
2164
|
+
* @example
|
|
2165
|
+
* `2017-11-01`;
|
|
2166
|
+
*
|
|
2167
|
+
* @summary Payment due date
|
|
2168
|
+
*
|
|
2169
|
+
* @name cbc:DueDate
|
|
2170
|
+
*/
|
|
2171
|
+
readonly dueDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
2172
|
+
/**
|
|
2173
|
+
* @summary INVOICE LINE
|
|
2174
|
+
*
|
|
2175
|
+
* @name cac:InvoiceLine
|
|
2176
|
+
*/
|
|
2177
|
+
readonly invoiceLines: Schema.$Array<typeof PeppolInvoiceLine>;
|
|
2178
|
+
/**
|
|
2179
|
+
* @example
|
|
2180
|
+
* `380`;
|
|
2181
|
+
*
|
|
2182
|
+
* @summary Invoice type code
|
|
2183
|
+
*
|
|
2184
|
+
* @name cbc:InvoiceTypeCode
|
|
2185
|
+
*/
|
|
2186
|
+
readonly invoiceTypeCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolInvoiceTypeCode">;
|
|
2187
|
+
/**
|
|
2188
|
+
* @summary PROJECT REFERENCE
|
|
2189
|
+
*
|
|
2190
|
+
* @name cac:ProjectReference
|
|
2191
|
+
*/
|
|
2192
|
+
readonly projectReference: Schema.optional<typeof PeppolProjectReference>;
|
|
2193
|
+
}>>;
|
|
2194
|
+
declare class PeppolInvoice extends PeppolInvoice_base {}
|
|
2195
|
+
//#endregion
|
|
2196
|
+
//#region src/schemas/fields/peppol-credit-note-line-schema.d.ts
|
|
2197
|
+
declare const PeppolCreditNoteLine_base: OpaqueSchema<PeppolCreditNoteLine, Schema.Struct<{
|
|
2198
|
+
readonly accountingCost: Schema.optional<Schema.String>;
|
|
2199
|
+
readonly allowanceCharges: Schema.optional<Schema.$Array<Schema.Union<readonly [typeof PeppolLineAllowance, typeof PeppolLineCharge]>>>;
|
|
2200
|
+
readonly documentReference: Schema.optional<Schema.$Array<Schema.Struct<{
|
|
2201
|
+
readonly id: Schema.String;
|
|
2202
|
+
readonly schemeId: Schema.optional<Schema.String>;
|
|
2203
|
+
readonly documentTypeCode: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
2204
|
+
}>>>;
|
|
2205
|
+
readonly id: Schema.String;
|
|
2206
|
+
readonly invoicePeriod: Schema.optional<typeof PeppolInvoiceLinePeriod>;
|
|
2207
|
+
readonly item: typeof PeppolLineItem;
|
|
2208
|
+
readonly lineExtensionAmount: typeof PeppolAmount;
|
|
2209
|
+
readonly note: Schema.optional<Schema.String>;
|
|
2210
|
+
readonly orderLineReference: Schema.optional<typeof PeppolOrderLineReference>;
|
|
2211
|
+
readonly price: typeof PeppolLinePrice;
|
|
2212
|
+
readonly creditedQuantity: Schema.Struct<{
|
|
2213
|
+
readonly value: Schema.Finite;
|
|
2214
|
+
readonly unitCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolQuantityUnitCode">;
|
|
2215
|
+
}>;
|
|
2216
|
+
}>>;
|
|
2217
|
+
/**
|
|
2218
|
+
* @description Credit note line is identical to Invoice line except the quantity element name.
|
|
2219
|
+
*/
|
|
2220
|
+
declare class PeppolCreditNoteLine extends PeppolCreditNoteLine_base {}
|
|
2221
|
+
interface PeppolCreditNoteLineEncoded extends Schema.Codec.Encoded<typeof PeppolCreditNoteLine> {}
|
|
2222
|
+
//#endregion
|
|
2223
|
+
//#region src/schemas/peppol-credit-note-schema.d.ts
|
|
2224
|
+
declare const PeppolCreditNote_base: OpaqueSchema<PeppolCreditNote, Schema.Struct<{
|
|
2225
|
+
readonly customizationId: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
2226
|
+
readonly profileId: Schema.withDecodingDefaultType<Schema.String, never>;
|
|
2227
|
+
readonly id: Schema.String;
|
|
2228
|
+
readonly issueDate: typeof PeppolIsoDateString;
|
|
2229
|
+
readonly note: Schema.optional<Schema.String>;
|
|
2230
|
+
readonly taxPointDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
2231
|
+
readonly documentCurrencyCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCurrencyCode">;
|
|
2232
|
+
readonly taxCurrencyCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCurrencyCode">>;
|
|
2233
|
+
readonly accountingCost: Schema.optional<Schema.String>;
|
|
2234
|
+
readonly buyerReference: Schema.optional<Schema.String>;
|
|
2235
|
+
readonly invoicePeriod: Schema.optional<typeof PeppolInvoicePeriod>;
|
|
2236
|
+
readonly orderReference: Schema.optional<typeof PeppolOrderReference>;
|
|
2237
|
+
readonly billingReferences: Schema.optional<Schema.$Array<typeof PeppolBillingReference>>;
|
|
2238
|
+
readonly despatchDocumentReference: Schema.optional<typeof PeppolDespatchDocumentReference>;
|
|
2239
|
+
readonly receiptDocumentReference: Schema.optional<typeof PeppolReceiptDocumentReference>;
|
|
2240
|
+
readonly originatorDocumentReference: Schema.optional<typeof PeppolOriginatorDocumentReference>;
|
|
2241
|
+
readonly contractDocumentReference: Schema.optional<typeof PeppolContractDocumentReference>;
|
|
2242
|
+
readonly additionalDocumentReferences: Schema.optional<Schema.$Array<typeof PeppolAdditionalDocumentReference>>;
|
|
2243
|
+
readonly accountingSupplierParty: typeof PeppolPartySchema;
|
|
2244
|
+
readonly accountingCustomerParty: typeof PeppolPartySchema;
|
|
2245
|
+
readonly payeeParty: Schema.optional<typeof PeppolPayeeParty>;
|
|
2246
|
+
readonly taxRepresentativeParty: Schema.optional<typeof PeppolTaxRepresentative>;
|
|
2247
|
+
readonly delivery: Schema.optional<typeof PeppolDelivery>;
|
|
2248
|
+
readonly paymentMeans: Schema.optional<Schema.$Array<typeof PeppolPaymentMeans>>;
|
|
2249
|
+
readonly paymentTerms: Schema.optional<typeof PeppolPaymentTerms>;
|
|
2250
|
+
readonly allowanceCharges: Schema.optional<Schema.$Array<Schema.Union<readonly [typeof PeppolAllowance, typeof PeppolCharge]>>>;
|
|
2251
|
+
readonly taxTotals: Schema.$Array<typeof PeppolTaxTotalsBase>;
|
|
2252
|
+
readonly legalMonetaryTotal: typeof PeppolLegalMonetaryTotal;
|
|
2253
|
+
/**
|
|
2254
|
+
* @description CREDIT NOTE LINE.
|
|
2255
|
+
*
|
|
2256
|
+
* @name cac:CreditNoteLine (1..n)
|
|
2257
|
+
*/
|
|
2258
|
+
readonly creditNoteLines: Schema.$Array<typeof PeppolCreditNoteLine>;
|
|
2259
|
+
/**
|
|
2260
|
+
* @description Invoice type code A code specifying the functional type of the Credit Note.
|
|
2261
|
+
*
|
|
2262
|
+
* @example
|
|
2263
|
+
* 381;
|
|
2264
|
+
*
|
|
2265
|
+
* @name cbc:CreditNoteTypeCode
|
|
2266
|
+
*/
|
|
2267
|
+
readonly creditNoteTypeCode: Schema.Literals<readonly ["81", "83", "381", "396", "532"]>;
|
|
2268
|
+
}>>;
|
|
2269
|
+
/**
|
|
2270
|
+
* @description Main UBL Credit Note schema (camelCase properties) Effect port of `creditNoteSchema` (`z.extend(billingBaseSchema, ...)` →
|
|
2271
|
+
* `PeppolBillingBase.pipe(Schema.fieldsAssign(...))`).
|
|
2272
|
+
*/
|
|
2273
|
+
declare class PeppolCreditNote extends PeppolCreditNote_base {}
|
|
2274
|
+
//#endregion
|
|
2275
|
+
//#region src/schemas/peppol-message-level-response-party-schema.d.ts
|
|
2276
|
+
declare const PeppolMessageLevelResponseParty_base: OpaqueSchema<PeppolMessageLevelResponseParty, Schema.Struct<{
|
|
2277
|
+
/**
|
|
2278
|
+
* @description Identifies the sender party's electronic address.
|
|
2279
|
+
*
|
|
2280
|
+
* @example
|
|
2281
|
+
* 7300010000001;
|
|
2282
|
+
*
|
|
2283
|
+
* @summary Sender/Receiver party's electronic address
|
|
2284
|
+
*
|
|
2285
|
+
* @name `cbc:EndpointID (+ @schemeID)`
|
|
2286
|
+
*/
|
|
2287
|
+
readonly endpointId: Schema.optional<typeof PeppolIdentifier>;
|
|
2288
|
+
}>>;
|
|
2289
|
+
declare class PeppolMessageLevelResponseParty extends PeppolMessageLevelResponseParty_base {}
|
|
2290
|
+
//#endregion
|
|
2291
|
+
//#region src/schemas/peppol-document-response-document-reference-schema.d.ts
|
|
2292
|
+
declare const PeppolDocumentResponseDocumentReference_base: OpaqueSchema<PeppolDocumentResponseDocumentReference, Schema.Struct<{
|
|
2293
|
+
/**
|
|
2294
|
+
* @description Identifies the document on which the message level response is based.
|
|
2295
|
+
*
|
|
2296
|
+
* @example
|
|
2297
|
+
* `EnvelopeID-12345`;
|
|
2298
|
+
*
|
|
2299
|
+
* @summary Document identifier
|
|
2300
|
+
*
|
|
2301
|
+
* @name `cbc:ID`
|
|
2302
|
+
*/
|
|
2303
|
+
readonly id: Schema.String;
|
|
2304
|
+
/**
|
|
2305
|
+
* @description The type of the document being referred to, expressed as a code.
|
|
2306
|
+
*
|
|
2307
|
+
* @summary Document type code
|
|
2308
|
+
*
|
|
2309
|
+
* @name `cbc:DocumentTypeCode`
|
|
2310
|
+
*/
|
|
2311
|
+
readonly documentTypeCode: Schema.optional<Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolDocumentTypeCode">>;
|
|
2312
|
+
/**
|
|
2313
|
+
* @description The version of the document that has been identifier with the document identifier.
|
|
2314
|
+
*
|
|
2315
|
+
* @example
|
|
2316
|
+
* `2`;
|
|
2317
|
+
*
|
|
2318
|
+
* @summary Document version identifier
|
|
2319
|
+
*
|
|
2320
|
+
* @name `cbc:VersionID`
|
|
2321
|
+
*/
|
|
2322
|
+
readonly versionId: Schema.optional<Schema.String>;
|
|
2323
|
+
}>>;
|
|
2324
|
+
declare class PeppolDocumentResponseDocumentReference extends PeppolDocumentResponseDocumentReference_base {}
|
|
2325
|
+
type PeppolMessageLevelDocumentResponseDocumentReference = PeppolDocumentResponseDocumentReference;
|
|
2326
|
+
//#endregion
|
|
2327
|
+
//#region src/schemas/peppol-document-response-document-schema.d.ts
|
|
2328
|
+
declare const PeppolDocumentResponseDocument_base: OpaqueSchema<PeppolDocumentResponseDocument, Schema.Struct<{
|
|
2329
|
+
/**
|
|
2330
|
+
* @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
|
|
2331
|
+
* response states that the document was not processed because of identified issues.
|
|
2332
|
+
*
|
|
2333
|
+
* @example
|
|
2334
|
+
* `RE`;
|
|
2335
|
+
*
|
|
2336
|
+
* @summary Message response code
|
|
2337
|
+
*
|
|
2338
|
+
* @name `cbc:ResponseCode`
|
|
2339
|
+
*/
|
|
2340
|
+
readonly responseCode: Schema.Literals<readonly ["AB", "AP", "RE"]>;
|
|
2341
|
+
/**
|
|
2342
|
+
* @description Used to meake any comments or instructions relevant to the response. The use of this element requires manual assessment by the receiver.
|
|
2343
|
+
*
|
|
2344
|
+
* @summary Response textual notes
|
|
2345
|
+
*/
|
|
2346
|
+
readonly description: Schema.optional<Schema.String>;
|
|
2347
|
+
}>>;
|
|
2348
|
+
/**
|
|
2349
|
+
* @summary Response information
|
|
2350
|
+
*
|
|
2351
|
+
* @name `cac:Response`
|
|
2352
|
+
*
|
|
2353
|
+
* @cardinality (1..1)
|
|
2354
|
+
*
|
|
2355
|
+
* @see {@link messageLevelResponseDocumentResponseSchema}
|
|
2356
|
+
*/
|
|
2357
|
+
declare class PeppolDocumentResponseDocument extends PeppolDocumentResponseDocument_base {}
|
|
2358
|
+
type PeppolMessageLevelResponseDocumentResponseDocument = PeppolDocumentResponseDocument;
|
|
2359
|
+
//#endregion
|
|
2360
|
+
//#region src/schemas/peppol-document-response-line-response-content-schema.d.ts
|
|
2361
|
+
declare const PeppolStatus_base: OpaqueSchema<PeppolStatus, Schema.Struct<{
|
|
2362
|
+
/**
|
|
2363
|
+
* @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...
|
|
2364
|
+
*
|
|
2365
|
+
* @summary Issue type coded
|
|
2366
|
+
*
|
|
2367
|
+
* @name `cbc:StatusReasonCode`
|
|
2368
|
+
*/
|
|
2369
|
+
readonly statusReasonCode: Schema.Literals<readonly ["BV", "BW", "SV"]>;
|
|
2370
|
+
}>>;
|
|
2371
|
+
declare class PeppolStatus extends PeppolStatus_base {}
|
|
2372
|
+
declare const PeppolDocumentResponseLineResponseContent_base: OpaqueSchema<PeppolDocumentResponseLineResponseContent, Schema.Struct<{
|
|
2373
|
+
/**
|
|
2374
|
+
* @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
|
|
2375
|
+
* response states that the document was not processed because of identified issues.
|
|
2376
|
+
*
|
|
2377
|
+
* @example
|
|
2378
|
+
* `RE`;
|
|
2379
|
+
*
|
|
2380
|
+
* @summary Line response code
|
|
2381
|
+
*
|
|
2382
|
+
* @name `cbc:ResponseCode`
|
|
2383
|
+
*/
|
|
2384
|
+
readonly responseCode: Schema.Literals<readonly ["AB", "AP", "RE"]>;
|
|
2385
|
+
/**
|
|
2386
|
+
* @description The description of the issued identifier in the transaction document.
|
|
2387
|
+
*
|
|
2388
|
+
* @example
|
|
2389
|
+
* `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;
|
|
2390
|
+
*
|
|
2391
|
+
* @summary Issue description
|
|
2392
|
+
*
|
|
2393
|
+
* @name `cbc:Description`
|
|
2394
|
+
*/
|
|
2395
|
+
readonly description: Schema.String;
|
|
2396
|
+
/**
|
|
2397
|
+
* @name `cac:Status`
|
|
2398
|
+
*/
|
|
2399
|
+
readonly status: typeof PeppolStatus;
|
|
2400
|
+
}>>;
|
|
2401
|
+
declare class PeppolDocumentResponseLineResponseContent extends PeppolDocumentResponseLineResponseContent_base {}
|
|
2402
|
+
//#endregion
|
|
2403
|
+
//#region src/schemas/peppol-document-response-line-response-schema.d.ts
|
|
2404
|
+
declare const PeppolLineReference_base: OpaqueSchema<PeppolLineReference, Schema.Struct<{
|
|
2405
|
+
/**
|
|
2406
|
+
* @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business
|
|
2407
|
+
* document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to
|
|
2408
|
+
* provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is
|
|
2409
|
+
* mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.
|
|
2410
|
+
*
|
|
2411
|
+
* @example
|
|
2412
|
+
* `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;
|
|
2413
|
+
*
|
|
2414
|
+
* @summary Section identifier
|
|
2415
|
+
*/
|
|
2416
|
+
readonly lineId: Schema.String;
|
|
2417
|
+
}>>;
|
|
2418
|
+
declare class PeppolLineReference extends PeppolLineReference_base {}
|
|
2419
|
+
declare const PeppolDocumentResponseLineResponse_base: OpaqueSchema<PeppolDocumentResponseLineResponse, Schema.Struct<{
|
|
2420
|
+
/**
|
|
2421
|
+
* @description Identifies the line in the business document to which the reported issue applies.
|
|
2422
|
+
*
|
|
2423
|
+
* @summary Line reference
|
|
2424
|
+
*
|
|
2425
|
+
* @name `cac:LineReference`
|
|
2426
|
+
*/
|
|
2427
|
+
readonly lineReference: typeof PeppolLineReference;
|
|
2428
|
+
/**
|
|
2429
|
+
* @summary Line response information
|
|
2430
|
+
*/
|
|
2431
|
+
readonly response: typeof PeppolDocumentResponseLineResponseContent;
|
|
2432
|
+
}>>;
|
|
2433
|
+
declare class PeppolDocumentResponseLineResponse extends PeppolDocumentResponseLineResponse_base {}
|
|
2434
|
+
type PeppolMessageLevelDocumentResponseLineResponse = PeppolDocumentResponseLineResponse;
|
|
2435
|
+
//#endregion
|
|
2436
|
+
//#region src/schemas/peppol-message-level-response-document-response-schema.d.ts
|
|
2437
|
+
declare const PeppolMessageLevelResponseDocumentResponse_base: OpaqueSchema<PeppolMessageLevelResponseDocumentResponse, Schema.Struct<{
|
|
2438
|
+
/**
|
|
2439
|
+
* @summary Response information
|
|
2440
|
+
*
|
|
2441
|
+
* @name `cac:Response`
|
|
2442
|
+
*
|
|
2443
|
+
* @cardinality (1..1)
|
|
2444
|
+
*/
|
|
2445
|
+
readonly response: typeof PeppolDocumentResponseDocument;
|
|
2446
|
+
/**
|
|
2447
|
+
* @description The document reference is used to provide a reference to the envelope of the business document on which the message level response is based.
|
|
2448
|
+
* The message level response message may only cover exactly one business document. The element
|
|
2449
|
+
* `cac:DocumentResponse/cac:DocumentReference/cbc:ID` **MUST** contain the instance identifier of the envelope of the original business
|
|
2450
|
+
* document.
|
|
2451
|
+
*
|
|
2452
|
+
* @summary Document reference
|
|
2453
|
+
*/
|
|
2454
|
+
readonly documentReference: typeof PeppolDocumentResponseDocumentReference;
|
|
2455
|
+
/**
|
|
2456
|
+
* @description A response to a particular line in the document. If the document response is negative (code='RE'), the line response element is used to specify
|
|
2457
|
+
* the errors in the business document.
|
|
2458
|
+
*
|
|
2459
|
+
* @summary Line response information
|
|
2460
|
+
*/
|
|
2461
|
+
readonly lineResponse: Schema.$Array<typeof PeppolDocumentResponseLineResponse>;
|
|
2462
|
+
}>>;
|
|
2463
|
+
declare class PeppolMessageLevelResponseDocumentResponse extends PeppolMessageLevelResponseDocumentResponse_base {}
|
|
2464
|
+
//#endregion
|
|
2465
|
+
//#region src/schemas/utils/peppol-xsd-time-schema.d.ts
|
|
2466
|
+
declare const PeppolXsdTime_base: OpaqueSchema<PeppolXsdTime, Schema.decodeTo<Schema.DateTimeUtc, Schema.String, never, never>>;
|
|
2467
|
+
/**
|
|
2468
|
+
* @description XSD `time` lexical value (`HH:MM:SS` with optional fractional seconds and timezone). Effect port of `xsdTime` (`z.string().check(z.regex(...))`):
|
|
2469
|
+
* keeps the value as a plain string and only validates the shape.
|
|
2470
|
+
*/
|
|
2471
|
+
declare class PeppolXsdTime extends PeppolXsdTime_base {}
|
|
2472
|
+
//#endregion
|
|
2473
|
+
//#region src/schemas/peppol-message-level-response-schema.d.ts
|
|
2474
|
+
declare const PeppolMessageLevelResponse_base: OpaqueSchema<PeppolMessageLevelResponse, Schema.Struct<{
|
|
2475
|
+
/**
|
|
2476
|
+
* @description Identifies the specification of content and rules that apply to the transaction.
|
|
2477
|
+
*
|
|
2478
|
+
* @default `urn:fdc:peppol.eu:poacc:trns:mlr:3`
|
|
2479
|
+
*
|
|
2480
|
+
* @summary Specification identification
|
|
2481
|
+
*
|
|
2482
|
+
* @name `cbc:CustomizationID`
|
|
2483
|
+
*
|
|
2484
|
+
* @cardinality 1..1
|
|
2485
|
+
*/
|
|
2486
|
+
readonly customizationId: Schema.String;
|
|
2487
|
+
/**
|
|
2488
|
+
* @description Identifies the BII profile or business process context in which the transaction appears.
|
|
2489
|
+
*
|
|
2490
|
+
* @remarks
|
|
2491
|
+
* Fixed value to `urn:fdc:peppol.eu:poacc:bis:mlr:3`
|
|
2492
|
+
*
|
|
2493
|
+
* @default `urn:fdc:peppol.eu:poacc:bis:mlr:3`
|
|
2494
|
+
*
|
|
2495
|
+
* @summary Business process type identifier
|
|
2496
|
+
*
|
|
2497
|
+
* @name `cbc:ProfileID`
|
|
2498
|
+
*/
|
|
2499
|
+
readonly profileId: Schema.Literal<"urn:fdc:peppol.eu:poacc:bis:mlr:3">;
|
|
2500
|
+
/**
|
|
2501
|
+
* @description A transaction instance must contain an identifier. The identifier enables positive referencing the transaction instance for various puropses
|
|
2502
|
+
* including referencing between transactions that are part of the same process.
|
|
2503
|
+
*
|
|
2504
|
+
* @example
|
|
2505
|
+
* 23;
|
|
2506
|
+
*
|
|
2507
|
+
* @summary Response identifier
|
|
2508
|
+
*
|
|
2509
|
+
* @name cbc:ID
|
|
2510
|
+
*/
|
|
2511
|
+
readonly id: Schema.String;
|
|
2512
|
+
/**
|
|
2513
|
+
* @description The date on which the transaction instance was issued.
|
|
2514
|
+
*
|
|
2515
|
+
* @example
|
|
2516
|
+
* 2017 - 11 - 01;
|
|
2517
|
+
*
|
|
2518
|
+
* @summary Response issue date
|
|
2519
|
+
*
|
|
2520
|
+
* @format `YYYY-MM-DD`
|
|
2521
|
+
*
|
|
2522
|
+
* @name cbc:IssueDate
|
|
2523
|
+
*/
|
|
2524
|
+
readonly issueDate: typeof PeppolIsoDateString;
|
|
2525
|
+
/**
|
|
2526
|
+
* @description The time at which the transaction instance was issued.
|
|
2527
|
+
*
|
|
2528
|
+
* @example
|
|
2529
|
+
* 12:01:34
|
|
2530
|
+
*
|
|
2531
|
+
* @summary Response issue time
|
|
2532
|
+
*
|
|
2533
|
+
* @format `hh:mm:ss`
|
|
2534
|
+
*
|
|
2535
|
+
* @name cbc:IssueDate
|
|
2536
|
+
*/
|
|
2537
|
+
readonly issueTime: Schema.optional<typeof PeppolXsdTime>;
|
|
2538
|
+
/**
|
|
2539
|
+
* @description The party sending an electronic message level response message back to the sending party of the business document.
|
|
2540
|
+
*
|
|
2541
|
+
* @summary Sender information
|
|
2542
|
+
*/
|
|
2543
|
+
readonly senderParty: typeof PeppolMessageLevelResponseParty;
|
|
2544
|
+
/**
|
|
2545
|
+
* @description The party, an electronic message level response was addressed to, and who is supposed to process the message level response. This is the same
|
|
2546
|
+
* party as the sender of the business document.
|
|
2547
|
+
*
|
|
2548
|
+
* @summary Receiver information
|
|
2549
|
+
*/
|
|
2550
|
+
readonly receiverParty: typeof PeppolMessageLevelResponseParty;
|
|
2551
|
+
/**
|
|
2552
|
+
* @description The document response is used to indicate the result of business document validation. The element
|
|
2553
|
+
* `cac:DocumentResponse/cac:Response/cbc:ResponseCode` MUST contain the overall result code.
|
|
2554
|
+
*
|
|
2555
|
+
* @summary Document response
|
|
2556
|
+
*
|
|
2557
|
+
* @name `cac:DocumentResponse`
|
|
2558
|
+
*/
|
|
2559
|
+
readonly documentResponse: typeof PeppolMessageLevelResponseDocumentResponse;
|
|
2560
|
+
}>>;
|
|
2561
|
+
declare class PeppolMessageLevelResponse extends PeppolMessageLevelResponse_base {}
|
|
2562
|
+
//#endregion
|
|
2563
|
+
//#region src/schemas/peppol-invoice-response-status-reason-code-schema.d.ts
|
|
2564
|
+
declare const PeppolInvoiceResponseStatusReasonCodeReason_base: OpaqueSchema<PeppolInvoiceResponseStatusReasonCodeReason, Schema.Struct<{
|
|
2565
|
+
readonly value: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolOpStatusReason">;
|
|
2566
|
+
/**
|
|
2567
|
+
* @description List identifier for clarification.
|
|
2568
|
+
*
|
|
2569
|
+
* @summary List identifier
|
|
2570
|
+
*
|
|
2571
|
+
* @name `@listId`
|
|
2572
|
+
*/
|
|
2573
|
+
readonly listId: Schema.Literal<"OPStatusReason">;
|
|
2574
|
+
}>>;
|
|
2575
|
+
declare class PeppolInvoiceResponseStatusReasonCodeReason extends PeppolInvoiceResponseStatusReasonCodeReason_base {}
|
|
2576
|
+
declare const PeppolInvoiceResponseStatusReasonCodeAction_base: OpaqueSchema<PeppolInvoiceResponseStatusReasonCodeAction, Schema.Struct<{
|
|
2577
|
+
readonly value: Schema.brand<Schema.Literals<readonly ["NOA", "PIN", "NIN", "CNF", "CNP", "CNA", "OTH"]>, "PeppolOpStatusAction">;
|
|
2578
|
+
/**
|
|
2579
|
+
* @description List identifier for clarification.
|
|
2580
|
+
*
|
|
2581
|
+
* @summary List identifier
|
|
2582
|
+
*
|
|
2583
|
+
* @name `@listId`
|
|
2584
|
+
*/
|
|
2585
|
+
readonly listId: Schema.Literal<"OPStatusAction">;
|
|
2586
|
+
}>>;
|
|
2587
|
+
declare class PeppolInvoiceResponseStatusReasonCodeAction extends PeppolInvoiceResponseStatusReasonCodeAction_base {}
|
|
2588
|
+
declare const peppolInvoiceResponseStatusReasonCodeSchema: Schema.Union<readonly [typeof PeppolInvoiceResponseStatusReasonCodeAction, typeof PeppolInvoiceResponseStatusReasonCodeReason]>;
|
|
2589
|
+
type PeppolInvoiceResponseStatusReasonCode = typeof peppolInvoiceResponseStatusReasonCodeSchema.Type;
|
|
2590
|
+
//#endregion
|
|
2591
|
+
//#region src/schemas/peppol-invoice-response-document-actual-response-status-schema.d.ts
|
|
2592
|
+
declare const PeppolInvoiceResponseCondition_base: OpaqueSchema<PeppolInvoiceResponseCondition, Schema.Struct<{
|
|
2593
|
+
/**
|
|
2594
|
+
* @description A code defining the type of the detail.
|
|
2595
|
+
*
|
|
2596
|
+
* @example
|
|
2597
|
+
* `BT-75`;
|
|
2598
|
+
*
|
|
2599
|
+
* @summary Detail type code
|
|
2600
|
+
*
|
|
2601
|
+
* @name `cbc:AttributeId`
|
|
2602
|
+
*/
|
|
2603
|
+
readonly attributeId: Schema.String;
|
|
2604
|
+
/**
|
|
2605
|
+
* @description The value of the detail.
|
|
2606
|
+
*
|
|
2607
|
+
* @example
|
|
2608
|
+
* `EU123456789`;
|
|
2609
|
+
*
|
|
2610
|
+
* @summary Detail value
|
|
2611
|
+
*
|
|
2612
|
+
* @name `cbc:Description`
|
|
2613
|
+
*/
|
|
2614
|
+
readonly description: Schema.optional<Schema.String>;
|
|
2615
|
+
}>>;
|
|
2616
|
+
declare class PeppolInvoiceResponseCondition extends PeppolInvoiceResponseCondition_base {}
|
|
2617
|
+
declare const PeppolInvoiceResponseDocumentActualResponseStatus_base: OpaqueSchema<PeppolInvoiceResponseDocumentActualResponseStatus, Schema.Struct<{
|
|
2618
|
+
/**
|
|
2619
|
+
* @description A code defining a clarification given for the invoice status.
|
|
2620
|
+
*
|
|
2621
|
+
* @summary Clarification code
|
|
2622
|
+
*
|
|
2623
|
+
* @name `cbc:StatusReasonCode`
|
|
2624
|
+
*/
|
|
2625
|
+
readonly statusReasonCode: Schema.optional<Schema.Union<readonly [typeof PeppolInvoiceResponseStatusReasonCodeAction, typeof PeppolInvoiceResponseStatusReasonCodeReason]>>;
|
|
2626
|
+
/**
|
|
2627
|
+
* @description The description of the clarification given for the invoice status.
|
|
2628
|
+
*
|
|
2629
|
+
* @example
|
|
2630
|
+
* `TAX reference not found`;
|
|
2631
|
+
*
|
|
2632
|
+
* @summary Clarification description
|
|
2633
|
+
*
|
|
2634
|
+
* @name `cbc:StatusReason
|
|
2635
|
+
*/
|
|
2636
|
+
readonly statusReason: Schema.optional<Schema.String>;
|
|
2637
|
+
/**
|
|
2638
|
+
* @summary Condition
|
|
2639
|
+
*
|
|
2640
|
+
* @name `cac:Condition`
|
|
2641
|
+
*/
|
|
2642
|
+
readonly condition: Schema.optional<Schema.$Array<typeof PeppolInvoiceResponseCondition>>;
|
|
2643
|
+
}>>;
|
|
2644
|
+
declare class PeppolInvoiceResponseDocumentActualResponseStatus extends PeppolInvoiceResponseDocumentActualResponseStatus_base {}
|
|
2645
|
+
type InvoiceResponseDocumentActualResponseStatus = PeppolInvoiceResponseDocumentActualResponseStatus;
|
|
2646
|
+
//#endregion
|
|
2647
|
+
//#region src/schemas/peppol-invoice-response-document-actual-response-schema.d.ts
|
|
2648
|
+
declare const withStatusCodes: Schema.Literals<readonly ["UQ", "RE", "CA"]>;
|
|
2649
|
+
declare const withoutStatusCodes: Schema.Literals<readonly ["AB", "AP", "IP", "PD"]>;
|
|
2650
|
+
declare const PeppolInvoiceResponseDocumentActualResponseWithoutStatus_base: OpaqueSchema<PeppolInvoiceResponseDocumentActualResponseWithoutStatus, Schema.Struct<{
|
|
2651
|
+
/**
|
|
2652
|
+
* @summary A code stating the status of the invoice in the process.
|
|
2653
|
+
*
|
|
2654
|
+
* @name `cbc:ResponseCode`
|
|
2655
|
+
*/
|
|
2656
|
+
readonly responseCode: Schema.Literals<readonly ["AB", "AP", "IP", "PD"]>;
|
|
2657
|
+
/**
|
|
2658
|
+
* @description The date when the status became effective.
|
|
2659
|
+
*
|
|
2660
|
+
* @example
|
|
2661
|
+
* `2018-08-02`;
|
|
2662
|
+
*
|
|
2663
|
+
* @summary Status date
|
|
2664
|
+
*
|
|
2665
|
+
* @name `cbc:EffectiveDate`
|
|
2666
|
+
*/
|
|
2667
|
+
readonly effectiveDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
2668
|
+
/**
|
|
2669
|
+
* @description Clarification is mendatory when the status is UQ-`under query`,RE-`rejected` and `CA`-Conditionally accepted. Clarification may be given as a
|
|
2670
|
+
* code, a description or both. If both are used, they must indicate the same clarification.
|
|
2671
|
+
*
|
|
2672
|
+
* @summary Clarification information
|
|
2673
|
+
*
|
|
2674
|
+
* @name `cac:Status`
|
|
2675
|
+
*/
|
|
2676
|
+
readonly status: Schema.optional<Schema.$Array<typeof PeppolInvoiceResponseDocumentActualResponseStatus>>;
|
|
2677
|
+
}>>;
|
|
2678
|
+
declare class PeppolInvoiceResponseDocumentActualResponseWithoutStatus extends PeppolInvoiceResponseDocumentActualResponseWithoutStatus_base {}
|
|
2679
|
+
declare const PeppolInvoiceResponseDocumentActualResponseWithStatus_base: OpaqueSchema<PeppolInvoiceResponseDocumentActualResponseWithStatus, Schema.Struct<{
|
|
2680
|
+
/**
|
|
2681
|
+
* @remarks
|
|
2682
|
+
* This is a rejection code that needs clarification in {@link status}
|
|
2683
|
+
*
|
|
2684
|
+
* @summary A code stating the status of the invoice in the process.
|
|
2685
|
+
*
|
|
2686
|
+
* @name `cbc:ResponseCode`
|
|
2687
|
+
*/
|
|
2688
|
+
readonly responseCode: Schema.Literals<readonly ["UQ", "RE", "CA"]>;
|
|
2689
|
+
/**
|
|
2690
|
+
* @description The date when the status became effective.
|
|
2691
|
+
*
|
|
2692
|
+
* @example
|
|
2693
|
+
* `2018-08-02`;
|
|
2694
|
+
*
|
|
2695
|
+
* @summary Status date
|
|
2696
|
+
*
|
|
2697
|
+
* @name `cbc:EffectiveDate`
|
|
2698
|
+
*/
|
|
2699
|
+
readonly effectiveDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
2700
|
+
/**
|
|
2701
|
+
* @description Clarification is mendatory when the status is UQ-`under query`,RE-`rejected` and `CA`-Conditionally accepted. Clarification may be given as a
|
|
2702
|
+
* code, a description or both. If both are used, they must indicate the same clarification.
|
|
2703
|
+
*
|
|
2704
|
+
* @summary Clarification information
|
|
2705
|
+
*
|
|
2706
|
+
* @name `cac:Status`
|
|
2707
|
+
*/
|
|
2708
|
+
readonly status: Schema.$Array<typeof PeppolInvoiceResponseDocumentActualResponseStatus>;
|
|
2709
|
+
}>>;
|
|
2710
|
+
declare class PeppolInvoiceResponseDocumentActualResponseWithStatus extends PeppolInvoiceResponseDocumentActualResponseWithStatus_base {}
|
|
2711
|
+
declare const peppolInvoiceResponseDocumentActualResponseSchema: Schema.Union<readonly [typeof PeppolInvoiceResponseDocumentActualResponseWithStatus, typeof PeppolInvoiceResponseDocumentActualResponseWithoutStatus]>;
|
|
2712
|
+
type InvoiceResponseDocumentActualResponse = typeof peppolInvoiceResponseDocumentActualResponseSchema.Type;
|
|
2713
|
+
//#endregion
|
|
2714
|
+
//#region src/schemas/utils/peppol-base-64-schema.d.ts
|
|
2715
|
+
/**
|
|
2716
|
+
* @description RFC 4648 base64 string (PEM / MIME / XML line endings tolerated). Effect port of `base64Schema` (`z.string().check(z.refine(...))`): strips CRLF /
|
|
2717
|
+
* LF line endings before testing the quantum regex.
|
|
2718
|
+
*/
|
|
2719
|
+
declare const peppolBase64Schema: Schema.String;
|
|
2720
|
+
type Base64 = typeof peppolBase64Schema.Type;
|
|
2721
|
+
//#endregion
|
|
2722
|
+
//#region src/schemas/utils/format-quantity-with-unit.d.ts
|
|
2723
|
+
declare function formatQuantityWithUnit(value: number, code: string, locale?: string, unitDisplay?: 'short' | 'narrow' | 'long'): string;
|
|
2724
|
+
//#endregion
|
|
2725
|
+
//#region src/schemas/values/credit-note-type-code-schema.d.ts
|
|
2726
|
+
/**
|
|
2727
|
+
* @description A credit note type code as defined by the PEPPOL subset of UNCL 1001 (credit note).
|
|
2728
|
+
*
|
|
2729
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
|
|
2730
|
+
*/
|
|
2731
|
+
type PeppolCreditNoteTypeCode = CreditNoteTypeCodesKeys;
|
|
2732
|
+
/**
|
|
2733
|
+
* @description Validates a credit note type code against the PEPPOL subset of UNCL 1001 (credit note).
|
|
2734
|
+
*
|
|
2735
|
+
* @param error - The custom error message to use when validation fails.
|
|
2736
|
+
*
|
|
2737
|
+
* @returns An Effect schema that accepts only valid credit note type codes.
|
|
2738
|
+
*
|
|
2739
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-cn/
|
|
2740
|
+
*/
|
|
2741
|
+
declare const creditNoteTypeCodeSchema: Schema.Literals<readonly ["81", "83", "381", "396", "532"]>;
|
|
2742
|
+
//#endregion
|
|
2743
|
+
//#region src/schemas/utils/get-credit-note-type-code-description.d.ts
|
|
2744
|
+
declare function getCreditNoteTypeCodeDescription(code: PeppolCreditNoteTypeCode): string;
|
|
2745
|
+
//#endregion
|
|
2746
|
+
//#region src/schemas/values/invoice-type-code-schema.d.ts
|
|
2747
|
+
/**
|
|
2748
|
+
* @description An invoice type code as defined by the PEPPOL subset of UNCL 1001 (invoice).
|
|
2749
|
+
*
|
|
2750
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/
|
|
2751
|
+
*/
|
|
2752
|
+
type PeppolInvoiceTypeCode = typeof invoiceTypeCodeSchema.Type;
|
|
2753
|
+
/**
|
|
2754
|
+
* @description Validates an invoice type code against the PEPPOL subset of UNCL 1001 (invoice).
|
|
2755
|
+
*
|
|
2756
|
+
* @param error - The custom error message to use when validation fails.
|
|
2757
|
+
*
|
|
2758
|
+
* @returns An Effect schema that accepts only valid invoice type codes.
|
|
2759
|
+
*
|
|
2760
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001-inv/
|
|
2761
|
+
*/
|
|
2762
|
+
declare const invoiceTypeCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolInvoiceTypeCode">;
|
|
2763
|
+
//#endregion
|
|
2764
|
+
//#region src/schemas/utils/get-invoice-type-code-description.d.ts
|
|
2765
|
+
declare function getInvoiceTypeCodeDescription(code: PeppolInvoiceTypeCode): string;
|
|
2766
|
+
//#endregion
|
|
2767
|
+
//#region src/schemas/utils/is-valid-credit-note-type-code.d.ts
|
|
2768
|
+
declare function isValidCreditNoteTypeCode(code: string): code is PeppolCreditNoteTypeCode;
|
|
2769
|
+
//#endregion
|
|
2770
|
+
//#region src/schemas/utils/is-valid-invoice-type-code.d.ts
|
|
2771
|
+
declare function isValidInvoiceTypeCode(code: string): code is PeppolInvoiceTypeCode;
|
|
2772
|
+
//#endregion
|
|
2773
|
+
//#region src/schemas/values/peppol-process-schema.d.ts
|
|
2774
|
+
/**
|
|
2775
|
+
* @description A PEPPOL business process identifier key as defined by the processes codelist.
|
|
2776
|
+
*
|
|
2777
|
+
* @see {@link processes}
|
|
2778
|
+
*/
|
|
2779
|
+
type PeppolProcesses = typeof peppolProcessSchema.Encoded;
|
|
2780
|
+
/**
|
|
2781
|
+
* @description Validates a full PEPPOL business process identifier (`<scheme>::<value>`) against the known processes.
|
|
2782
|
+
*
|
|
2783
|
+
* @param error - The custom error message to use when validation fails. Defaults to `'invalid peppol process identifier'`.
|
|
2784
|
+
*
|
|
2785
|
+
* @returns An Effect schema that matches a valid `scheme::value` process identifier.
|
|
2786
|
+
*
|
|
2787
|
+
* @see {@link processes}
|
|
2788
|
+
*/
|
|
2789
|
+
declare const peppolProcessSchema: Schema.TemplateLiteral<readonly [Schema.Literals<readonly ["cenbii-procid-ubl", "oioubl-procid-ubl"]>, Schema.Literal<"::">, Schema.String]>;
|
|
2790
|
+
//#endregion
|
|
2791
|
+
//#region src/schemas/utils/is-valid-process.d.ts
|
|
2792
|
+
declare function isValidProcess(code: string): code is PeppolProcesses;
|
|
2793
|
+
//#endregion
|
|
2794
|
+
//#region src/schemas/values/quantity-unit-codes-schema.d.ts
|
|
2795
|
+
/**
|
|
2796
|
+
* @description A unit of measure code as defined by the PEPPOL subset of UN/ECE Recommendation 20.
|
|
2797
|
+
*
|
|
2798
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNECERec20/
|
|
2799
|
+
*/
|
|
2800
|
+
type PeppolQuantityUnitCode = typeof quantityUnitCodesSchema.Type;
|
|
2801
|
+
/**
|
|
2802
|
+
* @description Validates a unit of measure code against the PEPPOL subset of UN/ECE Recommendation 20.
|
|
2803
|
+
*
|
|
2804
|
+
* @param error - The custom error message to use when validation fails.
|
|
2805
|
+
*
|
|
2806
|
+
* @returns An Effect schema that accepts only valid quantity unit codes.
|
|
2807
|
+
*
|
|
2808
|
+
* @validations
|
|
2809
|
+
* - BR-CL-23: Unit of measure code MUST be a valid UN/ECE Rec 20 code.
|
|
2810
|
+
*
|
|
2811
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNECERec20/
|
|
2812
|
+
*/
|
|
2813
|
+
declare const quantityUnitCodesSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolQuantityUnitCode">;
|
|
2814
|
+
//#endregion
|
|
2815
|
+
//#region src/schemas/utils/quantity-unit-code-to-intl-unit.d.ts
|
|
2816
|
+
type BaseIntlUnit = 'acre' | 'bit' | 'byte' | 'celsius' | 'centimeter' | 'degree' | 'fahrenheit' | 'fluid-ounce' | 'foot' | 'gallon' | 'gigabit' | 'gigabyte' | 'gram' | 'hectare' | 'inch' | 'kilobit' | 'kilobyte' | 'kilogram' | 'kilometer' | 'liter' | 'megabit' | 'megabyte' | 'meter' | 'mile' | 'mile-scandinavian' | 'milliliter' | 'millimeter' | 'ounce' | 'percent' | 'petabyte' | 'pound' | 'stone' | 'terabit' | 'terabyte' | 'yard';
|
|
2817
|
+
type TimeIntlUnit = 'nanosecond' | 'microsecond' | 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
|
|
2818
|
+
type IntlUnit = BaseIntlUnit | TimeIntlUnit | `${BaseIntlUnit}-per-${TimeIntlUnit}`;
|
|
2819
|
+
declare const quantityToIntlUnitMap: {
|
|
2820
|
+
CMT: "centimeter";
|
|
2821
|
+
MTR: "meter";
|
|
2822
|
+
MMT: "millimeter";
|
|
2823
|
+
KMT: "kilometer";
|
|
2824
|
+
INH: "inch";
|
|
2825
|
+
FOT: "foot";
|
|
2826
|
+
YRD: "yard";
|
|
2827
|
+
SMI: "mile";
|
|
2828
|
+
F49: "mile-scandinavian";
|
|
2829
|
+
ACR: "acre";
|
|
2830
|
+
H18: "hectare";
|
|
2831
|
+
LTR: "liter";
|
|
2832
|
+
MLT: "milliliter";
|
|
2833
|
+
GLI: "gallon";
|
|
2834
|
+
GLL: "gallon";
|
|
2835
|
+
OZA: "fluid-ounce";
|
|
2836
|
+
GRM: "gram";
|
|
2837
|
+
KGM: "kilogram";
|
|
2838
|
+
LBR: "pound";
|
|
2839
|
+
ONZ: "ounce";
|
|
2840
|
+
STI: "stone";
|
|
2841
|
+
STN: "stone";
|
|
2842
|
+
SEC: "second";
|
|
2843
|
+
MIN: "minute";
|
|
2844
|
+
HUR: "hour";
|
|
2845
|
+
DAY: "day";
|
|
2846
|
+
WEE: "week";
|
|
2847
|
+
MON: "month";
|
|
2848
|
+
ANN: "year";
|
|
2849
|
+
B98: "microsecond";
|
|
2850
|
+
C26: "millisecond";
|
|
2851
|
+
C47: "nanosecond";
|
|
2852
|
+
CEL: "celsius";
|
|
2853
|
+
FAH: "fahrenheit";
|
|
2854
|
+
A99: "bit";
|
|
2855
|
+
AD: "byte";
|
|
2856
|
+
'2P': "kilobyte";
|
|
2857
|
+
'4L': "megabyte";
|
|
2858
|
+
E34: "gigabyte";
|
|
2859
|
+
E35: "terabyte";
|
|
2860
|
+
E36: "petabyte";
|
|
2861
|
+
B68: "gigabit";
|
|
2862
|
+
B80: "gigabit";
|
|
2863
|
+
C21: "kilobit";
|
|
2864
|
+
B10: "bit";
|
|
2865
|
+
DD: "degree";
|
|
2866
|
+
P1: "percent";
|
|
2867
|
+
KMH: "kilometer-per-hour";
|
|
2868
|
+
MTS: "meter-per-second";
|
|
2869
|
+
HM: "mile-per-hour";
|
|
2870
|
+
KNT: "kilometer-per-hour";
|
|
2871
|
+
'2X': "meter-per-minute";
|
|
2872
|
+
'40': "milliliter-per-second";
|
|
2873
|
+
'41': "milliliter-per-minute";
|
|
2874
|
+
'4G': "milliliter";
|
|
2875
|
+
'4H': IntlUnit;
|
|
2876
|
+
A44: "liter";
|
|
2877
|
+
A45: "meter";
|
|
2878
|
+
A11: "meter";
|
|
2879
|
+
A12: "kilometer";
|
|
2880
|
+
B57: "kilometer";
|
|
2881
|
+
'4U': "pound-per-hour";
|
|
2882
|
+
'4M': IntlUnit;
|
|
2883
|
+
};
|
|
2884
|
+
declare function quantityUnitCodeToIntlUnit(code: PeppolQuantityUnitCode | (string & {})): IntlUnit | undefined;
|
|
2885
|
+
//#endregion
|
|
2886
|
+
//#region src/schemas/utils/peppol-vat-regex-schema.d.ts
|
|
2887
|
+
/**
|
|
2888
|
+
* @description EU VAT identification number (one member per member-state prefix/pattern). Effect port of `vatRegexSchema` (`z.union([...])` of
|
|
2889
|
+
* `z.string().check(...)` members): each member keeps its original prefix + pattern checks as `Schema.String.check` filters.
|
|
2890
|
+
*/
|
|
2891
|
+
declare const peppolVatRegexSchema: Schema.Union<readonly [Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String, Schema.String]>;
|
|
2892
|
+
type VatRegex = typeof peppolVatRegexSchema.Type;
|
|
2893
|
+
//#endregion
|
|
2894
|
+
//#region src/schemas/peppol-invoice-response-schema.d.ts
|
|
2895
|
+
declare const PeppolInvoiceResponseDocumentResponsePartyName_base: OpaqueSchema<PeppolInvoiceResponseDocumentResponsePartyName, Schema.Struct<{
|
|
2896
|
+
/**
|
|
2897
|
+
* @description - The party that issued the reference invoice
|
|
2898
|
+
* - The party who the referenced invoice is issued.
|
|
2899
|
+
*
|
|
2900
|
+
* @summary Seller/Buyer party name
|
|
2901
|
+
*
|
|
2902
|
+
* @name `cbc:Name`
|
|
2903
|
+
*/
|
|
2904
|
+
readonly name: Schema.String;
|
|
2905
|
+
}>>;
|
|
2906
|
+
declare class PeppolInvoiceResponseDocumentResponsePartyName extends PeppolInvoiceResponseDocumentResponsePartyName_base {}
|
|
2907
|
+
declare const PeppolInvoiceResponseParty_base: OpaqueSchema<PeppolInvoiceResponseParty, Schema.Struct<{
|
|
2908
|
+
readonly endpointId: Schema.optional<typeof PeppolIdentifier>;
|
|
2909
|
+
readonly partyIdentification: Schema.optional<typeof PeppolIdentifier>;
|
|
2910
|
+
readonly partyLegalEntity: Schema.Struct<{
|
|
2911
|
+
readonly registrationName: Schema.String;
|
|
2912
|
+
}>;
|
|
2913
|
+
}>>;
|
|
2914
|
+
declare class PeppolInvoiceResponseParty extends PeppolInvoiceResponseParty_base {}
|
|
2915
|
+
declare const PeppolInvoiceResponseSenderParty_base: OpaqueSchema<PeppolInvoiceResponseSenderParty, Schema.Struct<{
|
|
2916
|
+
readonly endpointId: Schema.optional<typeof PeppolIdentifier>;
|
|
2917
|
+
readonly partyIdentification: Schema.optional<typeof PeppolIdentifier>;
|
|
2918
|
+
readonly partyLegalEntity: Schema.Struct<{
|
|
2919
|
+
readonly registrationName: Schema.String;
|
|
2920
|
+
}>;
|
|
2921
|
+
readonly contact: Schema.optional<typeof PeppolContact>;
|
|
2922
|
+
}>>;
|
|
2923
|
+
declare class PeppolInvoiceResponseSenderParty extends PeppolInvoiceResponseSenderParty_base {}
|
|
2924
|
+
declare const PeppolInvoiceResponseDocumentResponseParty_base: OpaqueSchema<PeppolInvoiceResponseDocumentResponseParty, Schema.Struct<{
|
|
2925
|
+
/**
|
|
2926
|
+
* @summary Party partyIdentification
|
|
2927
|
+
*/
|
|
2928
|
+
readonly partyIdentification: Schema.optional<typeof PeppolIdentifier>;
|
|
2929
|
+
/**
|
|
2930
|
+
* @example
|
|
2931
|
+
* Seller Business Name AS
|
|
2932
|
+
*
|
|
2933
|
+
* @name cac:PartyName
|
|
2934
|
+
*/
|
|
2935
|
+
readonly partyName: typeof PeppolInvoiceResponseDocumentResponsePartyName;
|
|
2936
|
+
}>>;
|
|
2937
|
+
/**
|
|
2938
|
+
* @description Party schema used under `cac:DocumentReference/(cac:IssuerParty|cac:RecipientParty)`
|
|
2939
|
+
*/
|
|
2940
|
+
declare class PeppolInvoiceResponseDocumentResponseParty extends PeppolInvoiceResponseDocumentResponseParty_base {}
|
|
2941
|
+
type PeppolInvoiceDocumentResponseParty = PeppolInvoiceResponseDocumentResponseParty;
|
|
2942
|
+
declare const PeppolInvoiceResponseDocumentReference_base: OpaqueSchema<PeppolInvoiceResponseDocumentReference, Schema.Struct<{
|
|
2943
|
+
/**
|
|
2944
|
+
* @description An identifier for the invoice that the status applies to. The invoice identifier must be of the main invoice number that appears in the invoice
|
|
2945
|
+
* itself.
|
|
2946
|
+
*
|
|
2947
|
+
* @example
|
|
2948
|
+
* `inv-99876`;
|
|
2949
|
+
*
|
|
2950
|
+
* @summary Invoice identifier
|
|
2951
|
+
*
|
|
2952
|
+
* @name `cbc:ID`
|
|
2953
|
+
*/
|
|
2954
|
+
readonly id: Schema.String;
|
|
2955
|
+
/**
|
|
2956
|
+
* @description The date on which the referenced invoice was issued.
|
|
2957
|
+
*
|
|
2958
|
+
* @example
|
|
2959
|
+
* `2018-08-01`;
|
|
2960
|
+
*
|
|
2961
|
+
* @summary Invoice issue date
|
|
2962
|
+
*
|
|
2963
|
+
* @name `cbc:IssueDate`
|
|
2964
|
+
*/
|
|
2965
|
+
readonly issueDate: Schema.optional<typeof PeppolIsoDateString>;
|
|
2966
|
+
/**
|
|
2967
|
+
* @example
|
|
2968
|
+
* `380`;
|
|
2969
|
+
*
|
|
2970
|
+
* @summary Identifier type code
|
|
2971
|
+
*/
|
|
2972
|
+
readonly documentTypeCode: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolDocumentTypeCode">;
|
|
2973
|
+
}>>;
|
|
2974
|
+
declare class PeppolInvoiceResponseDocumentReference extends PeppolInvoiceResponseDocumentReference_base {}
|
|
2975
|
+
declare const PeppolInvoiceResponseDocumentResponse_base: OpaqueSchema<PeppolInvoiceResponseDocumentResponse, Schema.Struct<{
|
|
2976
|
+
/**
|
|
2977
|
+
* @summary Response information
|
|
2978
|
+
*
|
|
2979
|
+
* @name `cac:Response`
|
|
2980
|
+
*
|
|
2981
|
+
* @cardinality (1..1)
|
|
2982
|
+
*/
|
|
2983
|
+
readonly response: Schema.Union<readonly [typeof PeppolInvoiceResponseDocumentActualResponseWithStatus, typeof PeppolInvoiceResponseDocumentActualResponseWithoutStatus]>;
|
|
2984
|
+
/**
|
|
2985
|
+
* @summary Document reference
|
|
2986
|
+
*
|
|
2987
|
+
* @name `cac:DocumentReference`
|
|
2988
|
+
*/
|
|
2989
|
+
readonly documentReference: typeof PeppolInvoiceResponseDocumentReference;
|
|
2990
|
+
/**
|
|
2991
|
+
* @summary Seller party information
|
|
2992
|
+
*
|
|
2993
|
+
* @name `cac:IssuerParty`
|
|
2994
|
+
*/
|
|
2995
|
+
readonly issuerParty: Schema.optional<typeof PeppolInvoiceResponseDocumentResponseParty>;
|
|
2996
|
+
/**
|
|
2997
|
+
* @summary Buyer party information
|
|
2998
|
+
*
|
|
2999
|
+
* @name `cac:RecipientParty`
|
|
3000
|
+
*/
|
|
3001
|
+
readonly recipientParty: Schema.optional<typeof PeppolInvoiceResponseDocumentResponseParty>;
|
|
3002
|
+
}>>;
|
|
3003
|
+
declare class PeppolInvoiceResponseDocumentResponse extends PeppolInvoiceResponseDocumentResponse_base {}
|
|
3004
|
+
declare const PeppolInvoiceResponse_base: OpaqueSchema<PeppolInvoiceResponse, Schema.Struct<{
|
|
3005
|
+
readonly customizationId: Schema.String;
|
|
3006
|
+
readonly id: Schema.String;
|
|
3007
|
+
readonly issueDate: typeof PeppolIsoDateString;
|
|
3008
|
+
readonly issueTime: Schema.optional<typeof PeppolXsdTime>;
|
|
3009
|
+
readonly profileId: Schema.Literal<"urn:fdc:peppol.eu:poacc:bis:invoice_response:3">;
|
|
3010
|
+
/**
|
|
3011
|
+
* @description The party sending an electronic message level response message back to the sending party of the business document.
|
|
3012
|
+
*
|
|
3013
|
+
* @summary Sender information
|
|
3014
|
+
*/
|
|
3015
|
+
readonly senderParty: typeof PeppolInvoiceResponseSenderParty;
|
|
3016
|
+
/**
|
|
3017
|
+
* @description The party, an electronic message level response was addressed to, and who is supposed to process the message level response. This is the same
|
|
3018
|
+
* party as the sender of the business document.
|
|
3019
|
+
*
|
|
3020
|
+
* @summary Receiver information
|
|
3021
|
+
*/
|
|
3022
|
+
readonly receiverParty: typeof PeppolInvoiceResponseParty;
|
|
3023
|
+
/**
|
|
3024
|
+
* @description General comments or instructions that are revelant to the response as a whole.
|
|
3025
|
+
*
|
|
3026
|
+
* @example
|
|
3027
|
+
* `Please refere to previous email exchange regarding this invoice.`;
|
|
3028
|
+
*
|
|
3029
|
+
* @summary Invoice response note
|
|
3030
|
+
*/
|
|
3031
|
+
readonly note: Schema.optional<Schema.String>;
|
|
3032
|
+
/**
|
|
3033
|
+
* @summary Document response
|
|
3034
|
+
*/
|
|
3035
|
+
readonly documentResponse: typeof PeppolInvoiceResponseDocumentResponse;
|
|
3036
|
+
}>>;
|
|
3037
|
+
/**
|
|
3038
|
+
* @description The invoice response is a descendant of the message level response with more fields. Effect port of `invoiceResponseSchema`
|
|
3039
|
+
* (`z.extend(messageLevelResponse, ...)` → `messageLevelResponse.pipe(Schema.fieldsAssign(...))`), overriding `profileId` with
|
|
3040
|
+
* `Schema.Literal(INVOICE_RESPONSE_PROFILE_ID)` plus sender/receiver/documentResponse.
|
|
3041
|
+
*/
|
|
3042
|
+
declare class PeppolInvoiceResponse extends PeppolInvoiceResponse_base {}
|
|
3043
|
+
//#endregion
|
|
3044
|
+
//#region src/schemas/peppol-document-schema.d.ts
|
|
3045
|
+
declare const isPeppolInvoice: <I>(input: I) => input is I & PeppolInvoice;
|
|
3046
|
+
declare const isPeppolCreditNote: <I>(input: I) => input is I & PeppolCreditNote;
|
|
3047
|
+
declare const isPeppolMessageLevelResponse: <I>(input: I) => input is I & PeppolMessageLevelResponse;
|
|
3048
|
+
declare const isPeppolInvoiceResponse: <I>(input: I) => input is I & PeppolInvoiceResponse;
|
|
3049
|
+
/**
|
|
3050
|
+
* @description Union of every supported PEPPOL business document. Members discriminate cleanly: invoice vs credit note via `invoiceLines`/`creditNoteLines`,
|
|
3051
|
+
* message-level vs invoice response via the `profileId` literal.
|
|
3052
|
+
*/
|
|
3053
|
+
declare const peppolDocumentSchema: Schema.decodeTo<Schema.Union<readonly [typeof PeppolInvoice, typeof PeppolCreditNote, typeof PeppolMessageLevelResponse, typeof PeppolInvoiceResponse]>, Schema.String, never, never>;
|
|
3054
|
+
type PeppolDocumentEncoded = Schema.Codec.Encoded<typeof peppolDocumentSchema>;
|
|
3055
|
+
type PeppolDocumentDecoded = Schema.Schema.Type<typeof peppolDocumentSchema>;
|
|
3056
|
+
/**
|
|
3057
|
+
* @description This defines the types of documents that are sent/received through the peppol network.
|
|
3058
|
+
*/
|
|
3059
|
+
type PeppolDocument = PeppolInvoice | PeppolCreditNote;
|
|
3060
|
+
/**
|
|
3061
|
+
* @description This defines the types of message that are sent/received through the peppol network.
|
|
3062
|
+
*/
|
|
3063
|
+
type PeppolMessage = PeppolMessageLevelResponse | PeppolInvoiceResponse;
|
|
3064
|
+
type PeppolAllDocuments = PeppolDocument | PeppolMessage;
|
|
3065
|
+
type PeppolDocumentLine = PeppolInvoiceLine | PeppolCreditNoteLine;
|
|
3066
|
+
//#endregion
|
|
3067
|
+
//#region src/schemas/fields/default-customization-id.d.ts
|
|
3068
|
+
declare const DEFAULT_CUSTOMIZATION_ID: 'urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0';
|
|
3069
|
+
//#endregion
|
|
3070
|
+
//#region src/schemas/fields/default-profile-id.d.ts
|
|
3071
|
+
declare const DEFAULT_PROFILE_ID: 'urn:fdc:peppol.eu:2017:poacc:billing:01:1.0';
|
|
3072
|
+
//#endregion
|
|
3073
|
+
//#region src/schemas/fields/peppol-reference-schema.d.ts
|
|
3074
|
+
declare const PeppolReferenceId_base: OpaqueSchema<PeppolReferenceId, Schema.Struct<{
|
|
3075
|
+
readonly id: Schema.String;
|
|
3076
|
+
}>>;
|
|
3077
|
+
declare class PeppolReferenceId extends PeppolReferenceId_base {}
|
|
3078
|
+
declare const peppolReferenceSchema: Schema.Union<readonly [typeof PeppolReferenceId, Schema.Undefined]>;
|
|
3079
|
+
type PeppolReferenceSchema = typeof peppolReferenceSchema.Type;
|
|
3080
|
+
//#endregion
|
|
3081
|
+
//#region src/schemas/values/additional-document-reference-code-schema.d.ts
|
|
3082
|
+
/**
|
|
3083
|
+
* @description Additional document reference.
|
|
3084
|
+
*
|
|
3085
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1153/
|
|
3086
|
+
* @see {@link additionalDocumentReferenceCodesKeys}
|
|
3087
|
+
*/
|
|
3088
|
+
type PeppolAdditionalDocumentReferenceCode = typeof additionalDocumentReferenceCodeSchema.Type;
|
|
3089
|
+
/**
|
|
3090
|
+
* @description Validates an additional document reference code against the PEPPOL subset of UNCL 1153 (reference qualifiers).
|
|
3091
|
+
*
|
|
3092
|
+
* @param error - The custom error message to use when validation fails. Defaults to the generic message.
|
|
3093
|
+
*
|
|
3094
|
+
* @returns An Effect schema that accepts only valid additional document reference codes.
|
|
3095
|
+
*
|
|
3096
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1153/
|
|
3097
|
+
* @see {@link additionalDocumentReferenceCodesKeys}
|
|
3098
|
+
*/
|
|
3099
|
+
declare const additionalDocumentReferenceCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolAdditionalDocumentReferenceCode">;
|
|
3100
|
+
//#endregion
|
|
3101
|
+
//#region src/schemas/values/allowance-charge-reason-code-schema.d.ts
|
|
3102
|
+
/**
|
|
3103
|
+
* @description An allowance or charge reason code as defined by the PEPPOL subset of UNCL 5189.
|
|
3104
|
+
*
|
|
3105
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5189/
|
|
3106
|
+
*/
|
|
3107
|
+
type PeppolAllowanceChargeReasonCode = typeof allowanceChargeReasonCodeSchema.Type;
|
|
3108
|
+
/**
|
|
3109
|
+
* @description Validates an allowance or charge reason code against the PEPPOL subset of UNCL 5189 (D.16B).
|
|
3110
|
+
*
|
|
3111
|
+
* @param error - The custom error message to use when validation fails.
|
|
3112
|
+
*
|
|
3113
|
+
* @returns An Effect schema that accepts only valid allowance/charge reason codes.
|
|
3114
|
+
*
|
|
3115
|
+
* @validations
|
|
3116
|
+
* - PEPPOL-EN16931-CL002: Document allowance reason code MUST be according to the subset of UNCL 5189 D.16B.
|
|
3117
|
+
*
|
|
3118
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5189/
|
|
3119
|
+
*/
|
|
3120
|
+
declare const allowanceChargeReasonCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolAllowanceChargeReasonCode">;
|
|
3121
|
+
//#endregion
|
|
3122
|
+
//#region src/schemas/values/application-response-type-code-schema.d.ts
|
|
3123
|
+
/**
|
|
3124
|
+
* @description An application response type code as defined by the PEPPOL subset of UNCL 4343.
|
|
3125
|
+
*
|
|
3126
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
|
|
3127
|
+
*/
|
|
3128
|
+
type PeppolApplicationResponseTypeCode = ApplicationResponseTypeCodesKeys;
|
|
3129
|
+
/**
|
|
3130
|
+
* @description Validates an application response type code against the PEPPOL subset of UNCL 4343.
|
|
3131
|
+
*
|
|
3132
|
+
* @param error - The custom error message to use when validation fails.
|
|
3133
|
+
*
|
|
3134
|
+
* @returns An Effect schema that accepts only valid application response type codes.
|
|
3135
|
+
*
|
|
3136
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343/
|
|
3137
|
+
*/
|
|
3138
|
+
declare const applicationResponseTypeCodeSchema: Schema.Literals<readonly ["AB", "AP", "RE"]>;
|
|
3139
|
+
//#endregion
|
|
3140
|
+
//#region src/schemas/values/charge-reason-code-schema.d.ts
|
|
3141
|
+
/**
|
|
3142
|
+
* @description A charge reason code as defined by the PEPPOL subset of UNCL 7161.
|
|
3143
|
+
*
|
|
3144
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
|
|
3145
|
+
*/
|
|
3146
|
+
type PeppolChargeReasonCode = typeof chargeReasonCodeSchema.Type;
|
|
3147
|
+
/**
|
|
3148
|
+
* @description Validates a charge reason code against the PEPPOL subset of UNCL 7161 (D.16B).
|
|
3149
|
+
*
|
|
3150
|
+
* @param error - The custom error message to use when validation fails.
|
|
3151
|
+
*
|
|
3152
|
+
* @returns An Effect schema that accepts only valid charge reason codes.
|
|
3153
|
+
*
|
|
3154
|
+
* @validations
|
|
3155
|
+
* - PEPPOL-EN16931-CL003: Charge reason code MUST be according to UNCL 7161 D.16B.
|
|
3156
|
+
*
|
|
3157
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7161/
|
|
3158
|
+
*/
|
|
3159
|
+
declare const chargeReasonCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolChargeReasonCode">;
|
|
3160
|
+
//#endregion
|
|
3161
|
+
//#region src/schemas/values/peppol-country-code-schema.d.ts
|
|
3162
|
+
/**
|
|
3163
|
+
* @description An ISO 3166-1 alpha-2 country code as defined by the PEPPOL subset.
|
|
3164
|
+
*
|
|
3165
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO3166/
|
|
3166
|
+
*/
|
|
3167
|
+
type PeppolCountryCode = typeof peppolCountryCodeSchema.Type;
|
|
3168
|
+
/**
|
|
3169
|
+
* @description Validates a two character ISO 3166-1 alpha-2 country code against the PEPPOL codelist. All codes in the codelist are exactly 2 characters, so the
|
|
3170
|
+
* literals union implies the length check.
|
|
3171
|
+
*
|
|
3172
|
+
* @validations
|
|
3173
|
+
* - BR-CL-14 / BR-CL-15: Country code MUST be a valid ISO 3166-1 alpha-2 code.
|
|
3174
|
+
*
|
|
3175
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO3166/
|
|
3176
|
+
*/
|
|
3177
|
+
declare const peppolCountryCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCountryCode">;
|
|
3178
|
+
//#endregion
|
|
3179
|
+
//#region src/schemas/values/currency-code-schema.d.ts
|
|
3180
|
+
/**
|
|
3181
|
+
* @description An ISO 4217 currency code as defined by the PEPPOL subset.
|
|
3182
|
+
*
|
|
3183
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
|
|
3184
|
+
*/
|
|
3185
|
+
type PeppolCurrencyCode = Schema.Schema.Type<typeof currencyCodeSchema>;
|
|
3186
|
+
/**
|
|
3187
|
+
* @description An ISO 4217 currency code as defined by the PEPPOL subset.
|
|
3188
|
+
*
|
|
3189
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
|
|
3190
|
+
*/
|
|
3191
|
+
type PeppolCurrencyCodeEncoded = Schema.Codec.Encoded<typeof currencyCodeSchema>;
|
|
3192
|
+
/**
|
|
3193
|
+
* @description Validates an ISO 4217 currency code against the PEPPOL codelist.
|
|
3194
|
+
*
|
|
3195
|
+
* @param error - The custom error message to use when validation fails.
|
|
3196
|
+
*
|
|
3197
|
+
* @returns An Effect schema that accepts only valid currency codes.
|
|
3198
|
+
*
|
|
3199
|
+
* @validations
|
|
3200
|
+
* - PEPPOL-EN16931-CL007: Currency codes MUST be valid ISO 4217 codes.
|
|
3201
|
+
*
|
|
3202
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ISO4217/
|
|
3203
|
+
*/
|
|
3204
|
+
declare const currencyCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolCurrencyCode">;
|
|
3205
|
+
//#endregion
|
|
3206
|
+
//#region src/schemas/values/peppol-document-type-code-schema.d.ts
|
|
3207
|
+
/**
|
|
3208
|
+
* @description A document type code as defined by the PEPPOL subset of UNCL 1001 (document/message name code).
|
|
3209
|
+
*
|
|
3210
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001/
|
|
3211
|
+
*/
|
|
3212
|
+
type PeppolDocumentTypeCode = typeof peppolDocumentTypeCodeSchema.Type;
|
|
3213
|
+
/**
|
|
3214
|
+
* @description Validates a document type code against the PEPPOL subset of UNCL 1001.
|
|
3215
|
+
*
|
|
3216
|
+
* @param error - The custom error message to use when validation fails.
|
|
3217
|
+
*
|
|
3218
|
+
* @returns An Effect schema that accepts only valid document type codes.
|
|
3219
|
+
*
|
|
3220
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL1001/
|
|
3221
|
+
*/
|
|
3222
|
+
declare const peppolDocumentTypeCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolDocumentTypeCode">;
|
|
3223
|
+
//#endregion
|
|
3224
|
+
//#region src/schemas/values/peppol-document-type-schema.d.ts
|
|
3225
|
+
/**
|
|
3226
|
+
* @description One of the PEPPOL document type schemes (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).
|
|
3227
|
+
*
|
|
3228
|
+
* @see {@link documentTypesTable}
|
|
3229
|
+
*/
|
|
3230
|
+
type PeppolDocumentType = typeof peppolDocumentTypeSchema.Type;
|
|
3231
|
+
/**
|
|
3232
|
+
* @description Validates a full PEPPOL document type identifier (`<scheme>::<value>`) against the known document type table. The scheme prefix must be a known key
|
|
3233
|
+
* and the full identifier must exist in the document type table (checked via a filter).
|
|
3234
|
+
*
|
|
3235
|
+
* @param error - The custom error message to use when validation fails. Defaults to `'invalid peppol document type'`.
|
|
3236
|
+
*
|
|
3237
|
+
* @returns An Effect schema that matches a valid `scheme::value` document type identifier.
|
|
3238
|
+
*
|
|
3239
|
+
* @see {@link documentTypesTable}
|
|
3240
|
+
*/
|
|
3241
|
+
declare const peppolDocumentTypeSchema: Schema.TemplateLiteral<readonly [Schema.Literals<readonly ["busdox-docid-qns", "peppol-doctype-wildcard"]>, Schema.Literal<"::">, Schema.String]>;
|
|
3242
|
+
//#endregion
|
|
3243
|
+
//#region src/schemas/values/document-type-schemes-schema.d.ts
|
|
3244
|
+
/**
|
|
3245
|
+
* @description Validates a PEPPOL document type scheme (e.g. `busdox-docid-qns`, `peppol-doctype-wildcard`).
|
|
3246
|
+
*
|
|
3247
|
+
* @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type scheme'`.
|
|
3248
|
+
*
|
|
3249
|
+
* @returns An Effect schema that accepts only valid document type schemes.
|
|
3250
|
+
*
|
|
3251
|
+
* @see {@link documentTypesScheme}
|
|
3252
|
+
*/
|
|
3253
|
+
declare const documentTypeSchemesSchema: Schema.Literals<[string, ...string[]]>;
|
|
3254
|
+
//#endregion
|
|
3255
|
+
//#region src/schemas/values/document-type-values-schema.d.ts
|
|
3256
|
+
/**
|
|
3257
|
+
* @description Validates the value part of a PEPPOL document type identifier (the portion after the scheme prefix) against the known document type table.
|
|
3258
|
+
*
|
|
3259
|
+
* @param error - The error message to use when validation fails. Defaults to `'invalid Peppol document type value'`.
|
|
3260
|
+
*
|
|
3261
|
+
* @returns An Effect schema that accepts only valid document type values.
|
|
3262
|
+
*
|
|
3263
|
+
* @see {@link documentTypesTable}
|
|
3264
|
+
*/
|
|
3265
|
+
declare const documentTypeValuesSchema: Schema.String;
|
|
3266
|
+
//#endregion
|
|
3267
|
+
//#region src/schemas/values/duty-tax-fee-category-schema.d.ts
|
|
3268
|
+
/**
|
|
3269
|
+
* @description A duty, tax or fee category code as defined by the PEPPOL subset of UNCL 5305 (VAT category code).
|
|
3270
|
+
*
|
|
3271
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
|
|
3272
|
+
*/
|
|
3273
|
+
type PeppolDutyTaxFeeCategoryCode = typeof peppolDutyTaxFeeCategorySchema.Type;
|
|
3274
|
+
type PeppolDutyTaxFeeCategoryCodeEncoded = typeof peppolDutyTaxFeeCategorySchema.Encoded;
|
|
3275
|
+
/**
|
|
3276
|
+
* @description Validates a duty, tax or fee category code against the PEPPOL subset of UNCL 5305 (VAT category code).
|
|
3277
|
+
*
|
|
3278
|
+
* @param error - The custom error message to use when validation fails.
|
|
3279
|
+
*
|
|
3280
|
+
* @returns An Effect schema that accepts only valid duty/tax/fee category codes.
|
|
3281
|
+
*
|
|
3282
|
+
* @validations
|
|
3283
|
+
* - BR-CL-17 / BR-CL-18: VAT category code MUST be a valid UNCL 5305 code.
|
|
3284
|
+
*
|
|
3285
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL5305/
|
|
3286
|
+
*/
|
|
3287
|
+
declare const peppolDutyTaxFeeCategorySchema: Schema.brand<Schema.Literals<readonly ["AE", "E", "S", "Z", "G", "O", "K", "L", "M", "B"]>, "PeppolDutyTaxFeeCategoryCode">;
|
|
3288
|
+
//#endregion
|
|
3289
|
+
//#region src/schemas/values/electronic-codes-schema.d.ts
|
|
3290
|
+
/**
|
|
3291
|
+
* @description An electronic address scheme (EAS) code, identifying the scheme of an electronic address (e.g. `0088` for GLN).
|
|
3292
|
+
*
|
|
3293
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
|
|
3294
|
+
*/
|
|
3295
|
+
type PeppolElectronicAddressCode = typeof electronicCodesSchema.Type;
|
|
3296
|
+
/**
|
|
3297
|
+
* @description Validates an electronic address scheme (EAS) code against the PEPPOL Electronic Address Identifier Scheme codelist.
|
|
3298
|
+
*
|
|
3299
|
+
* @param error - The custom error message to use when validation fails.
|
|
3300
|
+
*
|
|
3301
|
+
* @returns An Effect schema that accepts only valid electronic address scheme codes.
|
|
3302
|
+
*
|
|
3303
|
+
* @validations
|
|
3304
|
+
* - PEPPOL-EN16931-CL008: Electronic address identifier scheme MUST be from the codelist "Electronic Address Identifier Scheme".
|
|
3305
|
+
*
|
|
3306
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/eas/
|
|
3307
|
+
*/
|
|
3308
|
+
declare const electronicCodesSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolElectronicAddressCode">;
|
|
3309
|
+
//#endregion
|
|
3310
|
+
//#region src/schemas/values/icd-codes-schema.d.ts
|
|
3311
|
+
/**
|
|
3312
|
+
* @description An ISO 6523 ICD (International Code Designator) code identifying an identifier scheme.
|
|
3313
|
+
*
|
|
3314
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
|
|
3315
|
+
*/
|
|
3316
|
+
type PeppolIcdCode = typeof icdCodesSchema.Type;
|
|
3317
|
+
/**
|
|
3318
|
+
* @description Validates an ISO 6523 ICD code against the PEPPOL codelist.
|
|
3319
|
+
*
|
|
3320
|
+
* @param error - The custom error message to use when validation fails. Defaults to `'Invalid ICD code provided'`.
|
|
3321
|
+
*
|
|
3322
|
+
* @returns An Effect schema that accepts only valid ICD codes.
|
|
3323
|
+
*
|
|
3324
|
+
* @validations
|
|
3325
|
+
* - BR-CL-10 / BR-CL-11 / BR-CL-21: Identifier scheme MUST be a valid ISO 6523 ICD code.
|
|
3326
|
+
*
|
|
3327
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/ICD/
|
|
3328
|
+
*/
|
|
3329
|
+
declare const icdCodesSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolIcdCode">;
|
|
3330
|
+
//#endregion
|
|
3331
|
+
//#region src/schemas/values/invoice-status-code-schema.d.ts
|
|
3332
|
+
/**
|
|
3333
|
+
* @description An invoice status code as defined by the PEPPOL subset of UNCL 4343 (T111).
|
|
3334
|
+
*
|
|
3335
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
|
|
3336
|
+
*/
|
|
3337
|
+
type PeppolInvoiceStatusCodes = typeof invoiceStatusCodeSchema.Type;
|
|
3338
|
+
/**
|
|
3339
|
+
* @description Validates an invoice status code against the PEPPOL subset of UNCL 4343 (T111).
|
|
3340
|
+
*
|
|
3341
|
+
* @param error - The custom error message to use when validation fails.
|
|
3342
|
+
*
|
|
3343
|
+
* @returns An Effect schema that accepts only valid invoice status codes.
|
|
3344
|
+
*
|
|
3345
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4343-T111/
|
|
3346
|
+
*/
|
|
3347
|
+
declare const invoiceStatusCodeSchema: Schema.brand<Schema.Literals<readonly ["AB", "AP", "RE", "IP", "UQ", "CA", "PD"]>, "PeppolInvoiceStatusCodes">;
|
|
3348
|
+
//#endregion
|
|
3349
|
+
//#region src/schemas/values/item-classification-codes-schema.d.ts
|
|
3350
|
+
/**
|
|
3351
|
+
* @description An item classification code as defined by the PEPPOL subset of UNCL 7143.
|
|
3352
|
+
*
|
|
3353
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7143/
|
|
3354
|
+
*/
|
|
3355
|
+
type PeppolItemClassificationCode = typeof itemClassificationCodesSchema.Type;
|
|
3356
|
+
/**
|
|
3357
|
+
* @description Validates an item classification code against the PEPPOL subset of UNCL 7143.
|
|
3358
|
+
*
|
|
3359
|
+
* @param error - The custom error message to use when validation fails.
|
|
3360
|
+
*
|
|
3361
|
+
* @returns An Effect schema that accepts only valid item classification codes.
|
|
3362
|
+
*
|
|
3363
|
+
* @validations
|
|
3364
|
+
* - BR-CL-13: Item classification scheme MUST be a valid UNTDID 7143 code.
|
|
3365
|
+
*
|
|
3366
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL7143/
|
|
3367
|
+
*/
|
|
3368
|
+
declare const itemClassificationCodesSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolItemClassificationCode">;
|
|
3369
|
+
//#endregion
|
|
3370
|
+
//#region src/schemas/values/mime-codes-schema.d.ts
|
|
3371
|
+
/**
|
|
3372
|
+
* @description A MIME media type code (e.g. `application/pdf`) as used for attached documents.
|
|
3373
|
+
*
|
|
3374
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/MimeCode/
|
|
3375
|
+
*/
|
|
3376
|
+
type PeppolMimeCode = typeof mimeCodesSchema.Type;
|
|
3377
|
+
/**
|
|
3378
|
+
* @description Validates a MIME media type against the PEPPOL MIME code list.
|
|
3379
|
+
*
|
|
3380
|
+
* @param error - The custom error message to use when validation fails.
|
|
3381
|
+
*
|
|
3382
|
+
* @returns An Effect schema that accepts only valid MIME types.
|
|
3383
|
+
*
|
|
3384
|
+
* @validations
|
|
3385
|
+
* - PEPPOL-EN16931-CL001: Attachment (MIME) type MUST come from the allowed list.
|
|
3386
|
+
*
|
|
3387
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/MimeCode/
|
|
3388
|
+
*/
|
|
3389
|
+
declare const mimeCodesSchema: Schema.brand<Schema.Literals<readonly ["text/csv", "application/pdf", "image/png", "image/jpeg", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.oasis.opendocument.spreadsheet"]>, "PeppolMimeCode">;
|
|
3390
|
+
//#endregion
|
|
3391
|
+
//#region src/schemas/values/op-status-action-schema.d.ts
|
|
3392
|
+
/**
|
|
3393
|
+
* @description An OpenPeppol operation status action code (e.g. the outcome of a message response).
|
|
3394
|
+
*
|
|
3395
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusAction/
|
|
3396
|
+
*/
|
|
3397
|
+
type PeppolOpStatusAction = typeof opStatusActionSchema.Type;
|
|
3398
|
+
/**
|
|
3399
|
+
* @description Validates an OpenPeppol operation status action code against the OPStatusAction codelist.
|
|
3400
|
+
*
|
|
3401
|
+
* @param error - The custom error message to use when validation fails.
|
|
3402
|
+
*
|
|
3403
|
+
* @returns An Effect schema that accepts only valid operation status action codes.
|
|
3404
|
+
*
|
|
3405
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusAction/
|
|
3406
|
+
*/
|
|
3407
|
+
declare const opStatusActionSchema: Schema.brand<Schema.Literals<readonly ["NOA", "PIN", "NIN", "CNF", "CNP", "CNA", "OTH"]>, "PeppolOpStatusAction">;
|
|
3408
|
+
//#endregion
|
|
3409
|
+
//#region src/schemas/values/op-status-reason-schema.d.ts
|
|
3410
|
+
/**
|
|
3411
|
+
* @description An OpenPeppol operation status reason code (e.g. the reason for a message response outcome).
|
|
3412
|
+
*
|
|
3413
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusReason/
|
|
3414
|
+
*/
|
|
3415
|
+
type PeppolOpStatusReason = typeof opStatusReasonSchema.Type;
|
|
3416
|
+
/**
|
|
3417
|
+
* @description Validates an OpenPeppol operation status reason code against the OPStatusReason codelist.
|
|
3418
|
+
*
|
|
3419
|
+
* @param error - The custom error message to use when validation fails.
|
|
3420
|
+
*
|
|
3421
|
+
* @returns An Effect schema that accepts only valid operation status reason codes.
|
|
3422
|
+
*
|
|
3423
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/OPStatusReason/
|
|
3424
|
+
*/
|
|
3425
|
+
declare const opStatusReasonSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolOpStatusReason">;
|
|
3426
|
+
//#endregion
|
|
3427
|
+
//#region src/schemas/values/participant-identifier-code-schema.d.ts
|
|
3428
|
+
/**
|
|
3429
|
+
* @description A PEPPOL participant identifier scheme, identifying the scheme of a participant identifier (e.g. EAS codes).
|
|
3430
|
+
*
|
|
3431
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/
|
|
3432
|
+
*/
|
|
3433
|
+
type PeppolParticipantIdentifierCode = typeof participantIdentifierCodeSchema.Type;
|
|
3434
|
+
/**
|
|
3435
|
+
* @description Validates a PEPPOL participant identifier scheme against the participant identifier schemes list.
|
|
3436
|
+
*
|
|
3437
|
+
* @param error - The custom error message to use when validation fails.
|
|
3438
|
+
*
|
|
3439
|
+
* @returns An Effect schema that accepts only valid participant identifier schemes.
|
|
3440
|
+
*/
|
|
3441
|
+
declare const participantIdentifierCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolParticipantIdentifierCode">;
|
|
3442
|
+
//#endregion
|
|
3443
|
+
//#region src/schemas/values/payment-means-code-schema.d.ts
|
|
3444
|
+
/**
|
|
3445
|
+
* @description A payment means code as defined by the PEPPOL subset of UNCL 4461.
|
|
3446
|
+
*
|
|
3447
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/
|
|
3448
|
+
*/
|
|
3449
|
+
type PeppolPaymentMeansCode = typeof paymentMeansCodeSchema.Type;
|
|
3450
|
+
/**
|
|
3451
|
+
* @description Validates a payment means code against the PEPPOL subset of UNCL 4461.
|
|
3452
|
+
*
|
|
3453
|
+
* @param error - The custom error message to use when validation fails.
|
|
3454
|
+
*
|
|
3455
|
+
* @returns An Effect schema that accepts only valid payment means codes.
|
|
3456
|
+
*
|
|
3457
|
+
* @validations
|
|
3458
|
+
* - BR-CL-16: Payment means code MUST be a valid UNCL 4461 code.
|
|
3459
|
+
*
|
|
3460
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/
|
|
3461
|
+
*/
|
|
3462
|
+
declare const paymentMeansCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolPaymentMeansCode">;
|
|
3463
|
+
//#endregion
|
|
3464
|
+
//#region src/schemas/values/process-from-document-type-schema.d.ts
|
|
3465
|
+
/**
|
|
3466
|
+
* @description Validates a business process identifier (`<scheme>::<value>`) against the processes allowed for a given document type.
|
|
3467
|
+
*
|
|
3468
|
+
* @param documentType - The PEPPOL document type scheme whose allowed processes should be used.
|
|
3469
|
+
* @param error - The custom error message to use when validation fails. Defaults to `'invalid process type for document type'`.
|
|
3470
|
+
*
|
|
3471
|
+
* @returns An Effect schema that matches only processes allowed for the given document type.
|
|
3472
|
+
*
|
|
3473
|
+
* @see {@link peppolProcessSchema}
|
|
3474
|
+
* @see {@link documentTypesProcessIds}
|
|
3475
|
+
*/
|
|
3476
|
+
declare function processFromDocumentTypeSchema(documentType: PeppolDocumentType, error?: string): Schema.String | Schema.TemplateLiteral<readonly [Schema.Literals<readonly ["cenbii-procid-ubl", "oioubl-procid-ubl"]>, Schema.Literal<"::">, Schema.String]>;
|
|
3477
|
+
//#endregion
|
|
3478
|
+
//#region src/schemas/values/vatex-code-schema.d.ts
|
|
3479
|
+
/**
|
|
3480
|
+
* @description A VAT exemption reason code as defined by the CEF VATEX codelist.
|
|
3481
|
+
*
|
|
3482
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/
|
|
3483
|
+
*/
|
|
3484
|
+
type PeppolVatexCode = typeof vatexCodeSchema.Type;
|
|
3485
|
+
/**
|
|
3486
|
+
* @description Validates a VAT exemption reason code against the CEF VATEX codelist.
|
|
3487
|
+
*
|
|
3488
|
+
* @param error - The custom error message to use when validation fails.
|
|
3489
|
+
*
|
|
3490
|
+
* @returns An Effect schema that accepts only valid VAT exemption reason codes.
|
|
3491
|
+
*
|
|
3492
|
+
* @validations
|
|
3493
|
+
* - BR-CL-22: VAT exemption reason code MUST be a valid CEF VATEX code.
|
|
3494
|
+
*
|
|
3495
|
+
* @see https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/
|
|
3496
|
+
*/
|
|
3497
|
+
declare const vatexCodeSchema: Schema.brand<Schema.Literals<[string, ...string[]]>, "PeppolVatexCode">;
|
|
3498
|
+
//#endregion
|
|
3499
|
+
//#region src/schemas/values/vat-date-code-schema.d.ts
|
|
3500
|
+
type PeppolVatDateCode = VatDateCodesKeys;
|
|
3501
|
+
/**
|
|
3502
|
+
* @validations
|
|
3503
|
+
* - PEPPOL-EN16931-CL006: Invoice period description code must be according to UNCL 2005 D.16B.
|
|
3504
|
+
*/
|
|
3505
|
+
declare const vatDateCodeSchema: Schema.Literals<readonly ["3", "35", "432"]>;
|
|
3506
|
+
//#endregion
|
|
3507
|
+
export { PeppolDocumentEncoded as $, PeppolPartyLegalEntity$1 as $n, PeppolMessageLevelResponseDocumentResponse as $t, peppolDocumentTypeSchema as A, PeppolBillingBase as An, PeppolInvoiceTypeCode as At, PeppolApplicationResponseTypeCode as B, PeppolTaxCategory as Bn, PeppolInvoiceResponseDocumentActualResponseWithoutStatus as Bt, electronicCodesSchema as C, PeppolInvoiceLinePeriod as Cn, quantityUnitCodesSchema as Ct, documentTypeValuesSchema as D, PeppolLineAllowanceChargeEncoded as Dn, isValidInvoiceTypeCode as Dt, peppolDutyTaxFeeCategorySchema as E, PeppolLineAllowanceCharge as En, peppolProcessSchema as Et, currencyCodeSchema as F, PeppolTaxTotal as Fn, formatQuantityWithUnit as Ft, additionalDocumentReferenceCodeSchema as G, PeppolPaymentMeans as Gn, PeppolInvoiceResponseCondition as Gt, PeppolAllowanceChargeReasonCode as H, PeppolTaxRepresentative as Hn, withStatusCodes as Ht, PeppolCountryCode as I, PeppolTaxTotalsBase as In, Base64 as It, DEFAULT_PROFILE_ID as J, PeppolPartyIdentification$1 as Jn, PeppolInvoiceResponseStatusReasonCodeAction as Jt, PeppolReferenceSchema as K, PeppolPayeeParty as Kn, PeppolInvoiceResponseDocumentActualResponseStatus as Kt, peppolCountryCodeSchema as L, PeppolTaxSubTotal as Ln, peppolBase64Schema as Lt, peppolDocumentTypeCodeSchema as M, PeppolDespatchDocumentReference as Mn, getCreditNoteTypeCodeDescription as Mt, PeppolCurrencyCode as N, PeppolOriginatorDocumentReference as Nn, PeppolCreditNoteTypeCode as Nt, documentTypeSchemesSchema as O, PeppolLineCharge as On, isValidCreditNoteTypeCode as Ot, PeppolCurrencyCodeEncoded as P, PeppolReceiptDocumentReference as Pn, creditNoteTypeCodeSchema as Pt, PeppolDocumentDecoded as Q, PeppolPartyTaxScheme as Qn, PeppolXsdTime as Qt, PeppolChargeReasonCode as R, PeppolTaxSubTotalCategory as Rn, InvoiceResponseDocumentActualResponse as Rt, PeppolElectronicAddressCode as S, PeppolItemClassification as Sn, PeppolQuantityUnitCode as St, PeppolDutyTaxFeeCategoryCodeEncoded as T, PeppolLineAllowance as Tn, PeppolProcesses as Tt, allowanceChargeReasonCodeSchema as U, PeppolTaxRepresentativeParty as Un, withoutStatusCodes as Ut, applicationResponseTypeCodeSchema as V, PeppolTaxSchemeId as Vn, peppolInvoiceResponseDocumentActualResponseSchema as Vt, PeppolAdditionalDocumentReferenceCode as W, PeppolPaymentTerms as Wn, InvoiceResponseDocumentActualResponseStatus as Wt, PeppolAllDocuments as X, PeppolPartySchema as Xn, peppolInvoiceResponseStatusReasonCodeSchema as Xt, DEFAULT_CUSTOMIZATION_ID as Y, PeppolPartyName$1 as Yn, PeppolInvoiceResponseStatusReasonCodeReason as Yt, PeppolDocument as Z, PeppolPartyTaxSchema as Zn, PeppolMessageLevelResponse as Zt, itemClassificationCodesSchema as _, PeppolQuantity as _n, peppolAllowanceChargeSchema as _r, BaseIntlUnit as _t, processFromDocumentTypeSchema as a, PeppolDocumentResponseDocumentReference as an, PeppolInvoicePeriod as ar, isPeppolMessageLevelResponse as at, PeppolIcdCode as b, PeppolItem as bn, PeppolIsoDateString as br, quantityToIntlUnitMap as bt, PeppolParticipantIdentifierCode as c, PeppolCreditNote as cn, PeppolBillingReference as cr, PeppolInvoiceResponse as ct, opStatusReasonSchema as d, PeppolInvoice as dn, BaseAllowanceCharge as dr, PeppolInvoiceResponseDocumentResponseParty as dt, PeppolDocumentResponseLineResponse as en, PeppolPartyLegalEntitySchema as er, PeppolDocumentLine as et, PeppolOpStatusAction as f, PeppolInvoiceLine as fn, PeppolAllowance as fr, PeppolInvoiceResponseDocumentResponsePartyName as ft, PeppolItemClassificationCode as g, PeppolLinePrice as gn, PeppolTaxCategoryTaxSchemeId as gr, peppolVatRegexSchema as gt, mimeCodesSchema as h, PeppolOrderLineReference as hn, PeppolCharge as hr, VatRegex as ht, vatexCodeSchema as i, PeppolMessageLevelResponseDocumentResponseDocument as in, PeppolLegalMonetaryTotal as ir, isPeppolInvoiceResponse as it, PeppolDocumentTypeCode as j, PeppolContractDocumentReference as jn, invoiceTypeCodeSchema as jt, PeppolDocumentType as k, peppolLineAllowanceChargeSchema as kn, getInvoiceTypeCodeDescription as kt, participantIdentifierCodeSchema as l, PeppolCreditNoteLine as ln, PeppolAdditionalDocumentReference as lr, PeppolInvoiceResponseDocumentReference as lt, PeppolMimeCode as m, PeppolBaseLine as mn, PeppolAllowanceChargeEncoded as mr, PeppolInvoiceResponseSenderParty as mt, vatDateCodeSchema as n, PeppolDocumentResponseLineResponseContent as nn, PeppolContact as nr, isPeppolCreditNote as nt, PeppolPaymentMeansCode as o, PeppolMessageLevelDocumentResponseDocumentReference as on, PeppolDelivery as or, peppolDocumentSchema as ot, opStatusActionSchema as p, PeppolInvoiceLineEncoded as pn, PeppolAllowanceCharge as pr, PeppolInvoiceResponseParty as pt, peppolReferenceSchema as q, PeppolPartyEndpointId as qn, PeppolInvoiceResponseStatusReasonCode as qt, PeppolVatexCode as r, PeppolDocumentResponseDocument as rn, PeppolOrderReference as rr, isPeppolInvoice as rt, paymentMeansCodeSchema as s, PeppolMessageLevelResponseParty as sn, PeppolAddress as sr, PeppolInvoiceDocumentResponseParty as st, PeppolVatDateCode as t, PeppolMessageLevelDocumentResponseLineResponse as tn, PeppolIdentifier as tr, PeppolMessage as tt, PeppolOpStatusReason as u, PeppolCreditNoteLineEncoded as un, PeppolBinaryObject as ur, PeppolInvoiceResponseDocumentResponse as ut, PeppolInvoiceStatusCodes as v, PeppolLinePriceAllowanceCharge as vn, PeppolAmount as vr, IntlUnit as vt, PeppolDutyTaxFeeCategoryCode as w, BaseLineAllowanceCharge as wn, isValidProcess as wt, icdCodesSchema as x, PeppolLineItem as xn, quantityUnitCodeToIntlUnit as xt, invoiceStatusCodeSchema as y, PriceAllowanceCharge as yn, PeppolAmountEncoded as yr, TimeIntlUnit as yt, chargeReasonCodeSchema as z, PeppolTaxSubTotalCategoryEncoded as zn, PeppolInvoiceResponseDocumentActualResponseWithStatus as zt };
|
|
3508
|
+
//# sourceMappingURL=index-CfjMSrpQ.d.ts.map
|