@factpulse/sdk 3.0.4 → 3.0.6
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/.openapi-generator/FILES +66 -4
- package/.openapi-generator/VERSION +1 -1
- package/CHANGELOG.md +3 -3
- package/api/document-conversion-api.ts +485 -0
- package/api/invoice-processing-api.ts +34 -34
- package/api.ts +1 -0
- package/dist/api/document-conversion-api.d.ts +226 -0
- package/dist/api/document-conversion-api.js +464 -0
- package/dist/api/invoice-processing-api.d.ts +33 -33
- package/dist/api/invoice-processing-api.js +16 -16
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/esm/api/document-conversion-api.d.ts +226 -0
- package/dist/esm/api/document-conversion-api.js +454 -0
- package/dist/esm/api/invoice-processing-api.d.ts +33 -33
- package/dist/esm/api/invoice-processing-api.js +16 -16
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/models/additional-document.d.ts +24 -0
- package/dist/esm/models/additional-document.js +14 -0
- package/dist/esm/models/allowance-charge.d.ts +31 -0
- package/dist/esm/models/allowance-charge.js +14 -0
- package/dist/esm/models/{apiprofile.d.ts → allowance-total-amount.d.ts} +3 -8
- package/dist/esm/models/allowance-total-amount.js +14 -0
- package/dist/esm/models/amount-due.d.ts +1 -1
- package/dist/{models/apiprofile.d.ts → esm/models/amount.d.ts} +3 -8
- package/dist/esm/models/amount.js +14 -0
- package/dist/esm/models/base-amount.d.ts +16 -0
- package/dist/esm/models/base-amount.js +14 -0
- package/dist/esm/models/charge-total-amount.d.ts +16 -0
- package/dist/esm/models/charge-total-amount.js +14 -0
- package/dist/esm/models/contact.d.ts +20 -0
- package/dist/esm/models/contact.js +14 -0
- package/dist/esm/models/convert-error-response.d.ts +27 -0
- package/dist/esm/models/convert-error-response.js +14 -0
- package/dist/esm/models/convert-pending-input-response.d.ts +31 -0
- package/dist/esm/models/convert-pending-input-response.js +14 -0
- package/dist/esm/models/convert-resume-request.d.ts +22 -0
- package/dist/esm/models/convert-resume-request.js +14 -0
- package/dist/esm/models/{document-type.d.ts → convert-success-response.d.ts} +29 -19
- package/dist/esm/models/convert-success-response.js +14 -0
- package/dist/{models/document-type.d.ts → esm/models/convert-validation-failed-response.d.ts} +25 -20
- package/dist/esm/models/convert-validation-failed-response.js +14 -0
- package/dist/esm/models/delivery-party.d.ts +22 -0
- package/dist/esm/models/delivery-party.js +14 -0
- package/dist/esm/models/document-type-info.d.ts +28 -0
- package/dist/esm/models/document-type-info.js +14 -0
- package/dist/esm/models/extraction-info.d.ts +32 -0
- package/dist/esm/models/extraction-info.js +14 -0
- package/dist/esm/models/factur-xinvoice.d.ts +19 -0
- package/dist/esm/models/factur-xprofile.d.ts +21 -0
- package/{models/apiprofile.ts → dist/esm/models/factur-xprofile.js} +5 -14
- package/dist/esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +4 -4
- package/dist/esm/models/file-info.d.ts +21 -0
- package/dist/esm/models/file-info.js +14 -0
- package/dist/esm/models/files-info.d.ts +19 -0
- package/dist/esm/models/files-info.js +14 -0
- package/dist/esm/models/generate-certificate-request.d.ts +5 -5
- package/dist/esm/models/get-chorus-pro-id-request.d.ts +1 -1
- package/dist/esm/models/get-invoice-request.d.ts +1 -1
- package/dist/esm/models/get-structure-request.d.ts +2 -2
- package/dist/esm/models/global-allowance-amount.d.ts +1 -1
- package/dist/esm/models/gross-unit-price.d.ts +16 -0
- package/dist/esm/models/gross-unit-price.js +14 -0
- package/dist/esm/models/incoming-invoice.d.ts +2 -2
- package/dist/esm/models/index.d.ts +32 -2
- package/dist/esm/models/index.js +32 -2
- package/dist/esm/models/invoice-line-allowance-amount.d.ts +1 -1
- package/dist/esm/models/invoice-line.d.ts +40 -6
- package/dist/esm/models/invoice-references.d.ts +20 -1
- package/dist/esm/models/invoice-totals-prepayment.d.ts +1 -1
- package/dist/esm/models/invoice-totals.d.ts +10 -2
- package/dist/esm/models/line-net-amount.d.ts +1 -1
- package/dist/esm/models/line-total-amount.d.ts +16 -0
- package/dist/esm/models/line-total-amount.js +14 -0
- package/dist/esm/models/manual-rate.d.ts +1 -1
- package/dist/esm/models/manual-vat-rate.d.ts +1 -1
- package/dist/esm/models/missing-field.d.ts +34 -0
- package/dist/esm/models/missing-field.js +14 -0
- package/dist/esm/models/payee.d.ts +2 -0
- package/dist/esm/models/payment-card.d.ts +18 -0
- package/dist/esm/models/payment-card.js +14 -0
- package/dist/esm/models/pdpcredentials.d.ts +5 -5
- package/dist/esm/models/percentage.d.ts +16 -0
- package/dist/esm/models/percentage.js +14 -0
- package/dist/esm/models/postal-address.d.ts +3 -1
- package/dist/esm/models/price-allowance-amount.d.ts +16 -0
- package/dist/esm/models/price-allowance-amount.js +14 -0
- package/dist/esm/models/price-basis-quantity.d.ts +16 -0
- package/dist/esm/models/price-basis-quantity.js +14 -0
- package/dist/esm/models/processing-options.d.ts +3 -3
- package/dist/esm/models/product-characteristic.d.ts +24 -0
- package/dist/esm/models/product-characteristic.js +14 -0
- package/dist/esm/models/product-classification.d.ts +22 -0
- package/dist/esm/models/product-classification.js +14 -0
- package/dist/esm/models/quantity.d.ts +1 -1
- package/dist/esm/models/recipient.d.ts +5 -1
- package/dist/esm/models/rounding-amount.d.ts +16 -0
- package/dist/esm/models/rounding-amount.js +14 -0
- package/dist/esm/models/scheme-id.d.ts +11 -5
- package/dist/esm/models/scheme-id.js +11 -5
- package/dist/esm/models/search-flow-request.d.ts +7 -7
- package/dist/esm/models/search-structure-request.d.ts +4 -4
- package/dist/esm/models/submit-flow-request.d.ts +6 -6
- package/dist/esm/models/submit-invoice-request.d.ts +13 -13
- package/dist/esm/models/supplier.d.ts +10 -1
- package/dist/esm/models/tax-representative.d.ts +29 -0
- package/dist/esm/models/tax-representative.js +14 -0
- package/dist/esm/models/taxable-amount.d.ts +1 -1
- package/dist/esm/models/total-gross-amount.d.ts +1 -1
- package/dist/esm/models/total-net-amount.d.ts +1 -1
- package/dist/esm/models/total-vatamount.d.ts +1 -1
- package/dist/esm/models/unit-net-price.d.ts +1 -1
- package/dist/esm/models/validation-info.d.ts +38 -0
- package/dist/esm/models/validation-info.js +14 -0
- package/dist/esm/models/vat-rate.d.ts +16 -0
- package/dist/esm/models/vat-rate.js +14 -0
- package/dist/esm/models/vatamount.d.ts +1 -1
- package/dist/esm/models/vatline.d.ts +3 -1
- package/dist/esm/models/vatpoint-date-code.d.ts +20 -0
- package/dist/esm/models/{apiprofile.js → vatpoint-date-code.js} +5 -6
- package/dist/models/additional-document.d.ts +24 -0
- package/dist/models/{apiprofile.js → additional-document.js} +0 -10
- package/dist/models/allowance-charge.d.ts +31 -0
- package/dist/models/allowance-charge.js +15 -0
- package/dist/models/allowance-total-amount.d.ts +16 -0
- package/dist/models/allowance-total-amount.js +15 -0
- package/dist/models/amount-due.d.ts +1 -1
- package/dist/models/amount.d.ts +16 -0
- package/dist/models/amount.js +15 -0
- package/dist/models/base-amount.d.ts +16 -0
- package/dist/models/base-amount.js +15 -0
- package/dist/models/charge-total-amount.d.ts +16 -0
- package/dist/models/charge-total-amount.js +15 -0
- package/dist/models/contact.d.ts +20 -0
- package/dist/models/contact.js +15 -0
- package/dist/models/convert-error-response.d.ts +27 -0
- package/dist/models/convert-error-response.js +15 -0
- package/dist/models/convert-pending-input-response.d.ts +31 -0
- package/dist/models/convert-pending-input-response.js +15 -0
- package/dist/models/convert-resume-request.d.ts +22 -0
- package/dist/models/convert-resume-request.js +15 -0
- package/dist/models/convert-success-response.d.ts +47 -0
- package/dist/models/convert-success-response.js +15 -0
- package/dist/models/{document-type.js → convert-validation-failed-response.d.ts} +25 -24
- package/dist/models/convert-validation-failed-response.js +15 -0
- package/dist/models/delivery-party.d.ts +22 -0
- package/dist/models/delivery-party.js +15 -0
- package/dist/models/document-type-info.d.ts +28 -0
- package/dist/models/document-type-info.js +15 -0
- package/dist/models/extraction-info.d.ts +32 -0
- package/dist/models/extraction-info.js +15 -0
- package/dist/models/factur-xinvoice.d.ts +19 -0
- package/dist/models/factur-xprofile.d.ts +21 -0
- package/dist/models/factur-xprofile.js +25 -0
- package/dist/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +4 -4
- package/dist/models/file-info.d.ts +21 -0
- package/dist/models/file-info.js +15 -0
- package/dist/models/files-info.d.ts +19 -0
- package/dist/models/files-info.js +15 -0
- package/dist/models/generate-certificate-request.d.ts +5 -5
- package/dist/models/get-chorus-pro-id-request.d.ts +1 -1
- package/dist/models/get-invoice-request.d.ts +1 -1
- package/dist/models/get-structure-request.d.ts +2 -2
- package/dist/models/global-allowance-amount.d.ts +1 -1
- package/dist/models/gross-unit-price.d.ts +16 -0
- package/dist/models/gross-unit-price.js +15 -0
- package/dist/models/incoming-invoice.d.ts +2 -2
- package/dist/models/index.d.ts +32 -2
- package/dist/models/index.js +32 -2
- package/dist/models/invoice-line-allowance-amount.d.ts +1 -1
- package/dist/models/invoice-line.d.ts +40 -6
- package/dist/models/invoice-references.d.ts +20 -1
- package/dist/models/invoice-totals-prepayment.d.ts +1 -1
- package/dist/models/invoice-totals.d.ts +10 -2
- package/dist/models/line-net-amount.d.ts +1 -1
- package/dist/models/line-total-amount.d.ts +16 -0
- package/dist/models/line-total-amount.js +15 -0
- package/dist/models/manual-rate.d.ts +1 -1
- package/dist/models/manual-vat-rate.d.ts +1 -1
- package/dist/models/missing-field.d.ts +34 -0
- package/dist/models/missing-field.js +15 -0
- package/dist/models/payee.d.ts +2 -0
- package/dist/models/payment-card.d.ts +18 -0
- package/dist/models/payment-card.js +15 -0
- package/dist/models/pdpcredentials.d.ts +5 -5
- package/dist/models/percentage.d.ts +16 -0
- package/dist/models/percentage.js +15 -0
- package/dist/models/postal-address.d.ts +3 -1
- package/dist/models/price-allowance-amount.d.ts +16 -0
- package/dist/models/price-allowance-amount.js +15 -0
- package/dist/models/price-basis-quantity.d.ts +16 -0
- package/dist/models/price-basis-quantity.js +15 -0
- package/dist/models/processing-options.d.ts +3 -3
- package/dist/models/product-characteristic.d.ts +24 -0
- package/dist/models/product-characteristic.js +15 -0
- package/dist/models/product-classification.d.ts +22 -0
- package/dist/models/product-classification.js +15 -0
- package/dist/models/quantity.d.ts +1 -1
- package/dist/models/recipient.d.ts +5 -1
- package/dist/models/rounding-amount.d.ts +16 -0
- package/dist/models/rounding-amount.js +15 -0
- package/dist/models/scheme-id.d.ts +11 -5
- package/dist/models/scheme-id.js +11 -5
- package/dist/models/search-flow-request.d.ts +7 -7
- package/dist/models/search-structure-request.d.ts +4 -4
- package/dist/models/submit-flow-request.d.ts +6 -6
- package/dist/models/submit-invoice-request.d.ts +13 -13
- package/dist/models/supplier.d.ts +10 -1
- package/dist/models/tax-representative.d.ts +29 -0
- package/dist/models/tax-representative.js +15 -0
- package/dist/models/taxable-amount.d.ts +1 -1
- package/dist/models/total-gross-amount.d.ts +1 -1
- package/dist/models/total-net-amount.d.ts +1 -1
- package/dist/models/total-vatamount.d.ts +1 -1
- package/dist/models/unit-net-price.d.ts +1 -1
- package/dist/models/validation-info.d.ts +38 -0
- package/dist/models/validation-info.js +15 -0
- package/dist/models/vat-rate.d.ts +16 -0
- package/dist/models/vat-rate.js +15 -0
- package/dist/models/vatamount.d.ts +1 -1
- package/dist/models/vatline.d.ts +3 -1
- package/dist/models/vatpoint-date-code.d.ts +20 -0
- package/dist/models/vatpoint-date-code.js +24 -0
- package/docs/AdditionalDocument.md +29 -0
- package/docs/AllowanceCharge.md +35 -0
- package/docs/AllowanceTotalAmount.md +19 -0
- package/docs/Amount.md +19 -0
- package/docs/AmountDue.md +1 -1
- package/docs/BaseAmount.md +19 -0
- package/docs/ChargeTotalAmount.md +19 -0
- package/docs/Contact.md +27 -0
- package/docs/ConvertErrorResponse.md +29 -0
- package/docs/ConvertPendingInputResponse.md +35 -0
- package/docs/ConvertResumeRequest.md +21 -0
- package/docs/ConvertSuccessResponse.md +39 -0
- package/docs/ConvertValidationFailedResponse.md +37 -0
- package/docs/DeliveryParty.md +27 -0
- package/docs/DocumentConversionApi.md +297 -0
- package/docs/DocumentTypeInfo.md +25 -0
- package/docs/ExtractionInfo.md +27 -0
- package/docs/FacturXInvoice.md +28 -0
- package/docs/{APIProfile.md → FacturXProfile.md} +2 -2
- package/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +8 -8
- package/docs/FileInfo.md +23 -0
- package/docs/FilesInfo.md +23 -0
- package/docs/GenerateCertificateRequest.md +10 -10
- package/docs/GetChorusProIdRequest.md +2 -2
- package/docs/GetInvoiceRequest.md +2 -2
- package/docs/GetStructureRequest.md +4 -4
- package/docs/GlobalAllowanceAmount.md +1 -1
- package/docs/GrossUnitPrice.md +19 -0
- package/docs/IncomingInvoice.md +1 -1
- package/docs/InvoiceLine.md +48 -14
- package/docs/InvoiceLineAllowanceAmount.md +1 -1
- package/docs/InvoiceProcessingApi.md +8 -8
- package/docs/InvoiceReferences.md +25 -5
- package/docs/InvoiceTotals.md +11 -3
- package/docs/InvoiceTotalsPrepayment.md +1 -1
- package/docs/LineNetAmount.md +1 -1
- package/docs/LineTotalAmount.md +19 -0
- package/docs/ManualRate.md +1 -1
- package/docs/ManualVatRate.md +1 -1
- package/docs/MissingField.md +31 -0
- package/docs/PDPCredentials.md +10 -10
- package/docs/Payee.md +4 -0
- package/docs/PaymentCard.md +23 -0
- package/docs/Percentage.md +19 -0
- package/docs/PostalAddress.md +5 -1
- package/docs/PriceAllowanceAmount.md +19 -0
- package/docs/PriceBasisQuantity.md +19 -0
- package/docs/ProcessingOptions.md +3 -3
- package/docs/ProductCharacteristic.md +23 -0
- package/docs/ProductClassification.md +25 -0
- package/docs/Quantity.md +1 -1
- package/docs/Recipient.md +7 -1
- package/docs/RoundingAmount.md +19 -0
- package/docs/SchemeID.md +17 -5
- package/docs/SearchFlowRequest.md +14 -14
- package/docs/SearchStructureRequest.md +8 -8
- package/docs/SubmitFlowRequest.md +12 -12
- package/docs/SubmitInvoiceRequest.md +26 -26
- package/docs/Supplier.md +17 -1
- package/docs/TaxRepresentative.md +25 -0
- package/docs/TaxableAmount.md +1 -1
- package/docs/TotalGrossAmount.md +1 -1
- package/docs/TotalNetAmount.md +1 -1
- package/docs/TotalVATAmount.md +1 -1
- package/docs/UnitNetPrice.md +1 -1
- package/docs/VATAmount.md +1 -1
- package/docs/VATLine.md +3 -1
- package/docs/VATPointDateCode.md +13 -0
- package/docs/ValidationInfo.md +31 -0
- package/docs/VatRate.md +19 -0
- package/models/additional-document.ts +30 -0
- package/models/{document-type.ts → allowance-charge.ts} +25 -27
- package/models/allowance-total-amount.ts +22 -0
- package/models/amount-due.ts +1 -1
- package/models/amount.ts +22 -0
- package/models/base-amount.ts +22 -0
- package/models/charge-total-amount.ts +22 -0
- package/models/contact.ts +26 -0
- package/models/convert-error-response.ts +33 -0
- package/models/convert-pending-input-response.ts +39 -0
- package/models/convert-resume-request.ts +26 -0
- package/models/convert-success-response.ts +59 -0
- package/models/convert-validation-failed-response.ts +52 -0
- package/models/delivery-party.ts +32 -0
- package/models/document-type-info.ts +34 -0
- package/models/extraction-info.ts +38 -0
- package/models/factur-xinvoice.ts +29 -0
- package/models/factur-xprofile.ts +31 -0
- package/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.ts +4 -4
- package/models/file-info.ts +27 -0
- package/models/files-info.ts +27 -0
- package/models/generate-certificate-request.ts +5 -5
- package/models/get-chorus-pro-id-request.ts +1 -1
- package/models/get-invoice-request.ts +1 -1
- package/models/get-structure-request.ts +2 -2
- package/models/global-allowance-amount.ts +1 -1
- package/models/gross-unit-price.ts +22 -0
- package/models/incoming-invoice.ts +4 -4
- package/models/index.ts +32 -2
- package/models/invoice-line-allowance-amount.ts +1 -1
- package/models/invoice-line.ts +56 -6
- package/models/invoice-references.ts +20 -1
- package/models/invoice-totals-prepayment.ts +1 -1
- package/models/invoice-totals.ts +18 -2
- package/models/line-net-amount.ts +1 -1
- package/models/line-total-amount.ts +22 -0
- package/models/manual-rate.ts +1 -1
- package/models/manual-vat-rate.ts +1 -1
- package/models/missing-field.ts +40 -0
- package/models/payee.ts +2 -0
- package/models/payment-card.ts +24 -0
- package/models/pdpcredentials.ts +5 -5
- package/models/percentage.ts +22 -0
- package/models/postal-address.ts +3 -1
- package/models/price-allowance-amount.ts +22 -0
- package/models/price-basis-quantity.ts +22 -0
- package/models/processing-options.ts +3 -3
- package/models/product-characteristic.ts +30 -0
- package/models/product-classification.ts +28 -0
- package/models/quantity.ts +1 -1
- package/models/recipient.ts +7 -1
- package/models/rounding-amount.ts +22 -0
- package/models/scheme-id.ts +11 -5
- package/models/search-flow-request.ts +7 -7
- package/models/search-structure-request.ts +4 -4
- package/models/submit-flow-request.ts +6 -6
- package/models/submit-invoice-request.ts +13 -13
- package/models/supplier.ts +12 -1
- package/models/tax-representative.ts +37 -0
- package/models/taxable-amount.ts +1 -1
- package/models/total-gross-amount.ts +1 -1
- package/models/total-net-amount.ts +1 -1
- package/models/total-vatamount.ts +1 -1
- package/models/unit-net-price.ts +1 -1
- package/{dist/esm/models/document-type.js → models/validation-info.ts} +28 -20
- package/models/vat-rate.ts +22 -0
- package/models/vatamount.ts +1 -1
- package/models/vatline.ts +5 -1
- package/models/vatpoint-date-code.ts +30 -0
- package/package.json +1 -1
- package/docs/DocumentType.md +0 -17
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Payment card information (BG-18). Used when payment is made by payment card.
|
|
19
|
+
*/
|
|
20
|
+
export interface PaymentCard {
|
|
21
|
+
'card_id'?: string | null;
|
|
22
|
+
'cardholder_name'?: string | null;
|
|
23
|
+
}
|
|
24
|
+
|
package/models/pdpcredentials.ts
CHANGED
|
@@ -21,19 +21,19 @@ export interface PDPCredentials {
|
|
|
21
21
|
/**
|
|
22
22
|
* Base URL of the AFNOR Flow Service
|
|
23
23
|
*/
|
|
24
|
-
'
|
|
25
|
-
'
|
|
24
|
+
'flowServiceUrl': string;
|
|
25
|
+
'directoryServiceUrl'?: string | null;
|
|
26
26
|
/**
|
|
27
27
|
* OAuth2 server URL
|
|
28
28
|
*/
|
|
29
|
-
'
|
|
29
|
+
'tokenUrl': string;
|
|
30
30
|
/**
|
|
31
31
|
* OAuth2 Client ID
|
|
32
32
|
*/
|
|
33
|
-
'
|
|
33
|
+
'clientId': string;
|
|
34
34
|
/**
|
|
35
35
|
* OAuth2 Client Secret (sensitive)
|
|
36
36
|
*/
|
|
37
|
-
'
|
|
37
|
+
'clientSecret': string;
|
|
38
38
|
}
|
|
39
39
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Percentage applied to base amount (BT-94/101/138/143).
|
|
19
|
+
*/
|
|
20
|
+
export interface Percentage {
|
|
21
|
+
}
|
|
22
|
+
|
package/models/postal-address.ts
CHANGED
|
@@ -15,13 +15,15 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* Represents a postal address.
|
|
18
|
+
* Represents a postal address (BG-5, BG-8, BG-12, BG-15).
|
|
19
19
|
*/
|
|
20
20
|
export interface PostalAddress {
|
|
21
21
|
'postalCode'?: string | null;
|
|
22
22
|
'lineOne'?: string | null;
|
|
23
23
|
'lineTwo'?: string | null;
|
|
24
|
+
'lineThree'?: string | null;
|
|
24
25
|
'city'?: string | null;
|
|
25
26
|
'countryCode'?: string | null;
|
|
27
|
+
'countrySubdivision'?: string | null;
|
|
26
28
|
}
|
|
27
29
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Item price discount amount (BT-147).
|
|
19
|
+
*/
|
|
20
|
+
export interface PriceAllowanceAmount {
|
|
21
|
+
}
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Item price base quantity (BT-149). Default is 1.
|
|
19
|
+
*/
|
|
20
|
+
export interface PriceBasisQuantity {
|
|
21
|
+
}
|
|
22
|
+
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
// May contain unused imports in some cases
|
|
17
17
|
// @ts-ignore
|
|
18
|
-
import type {
|
|
18
|
+
import type { FacturXProfile } from './factur-xprofile';
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* Processing options for generation and submission.
|
|
@@ -24,7 +24,7 @@ export interface ProcessingOptions {
|
|
|
24
24
|
/**
|
|
25
25
|
* Factur-X profile to use
|
|
26
26
|
*/
|
|
27
|
-
'facturxProfile'?:
|
|
27
|
+
'facturxProfile'?: FacturXProfile;
|
|
28
28
|
/**
|
|
29
29
|
* Auto-enrich data (Company APIs, Chorus Pro, etc.)
|
|
30
30
|
*/
|
|
@@ -32,7 +32,7 @@ export interface ProcessingOptions {
|
|
|
32
32
|
/**
|
|
33
33
|
* Validate Factur-X XML with Schematron
|
|
34
34
|
*/
|
|
35
|
-
'
|
|
35
|
+
'validateXml'?: boolean;
|
|
36
36
|
/**
|
|
37
37
|
* Verify required parameters for destination (e.g., service_code for Chorus)
|
|
38
38
|
*/
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Item attribute (BG-32). Additional product characteristics as key-value pairs.
|
|
19
|
+
*/
|
|
20
|
+
export interface ProductCharacteristic {
|
|
21
|
+
/**
|
|
22
|
+
* Attribute name (BT-160).
|
|
23
|
+
*/
|
|
24
|
+
'name': string;
|
|
25
|
+
/**
|
|
26
|
+
* Attribute value (BT-161).
|
|
27
|
+
*/
|
|
28
|
+
'value': string;
|
|
29
|
+
}
|
|
30
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Item classification identifier (BG-31). Product classification according to a classification scheme.
|
|
19
|
+
*/
|
|
20
|
+
export interface ProductClassification {
|
|
21
|
+
/**
|
|
22
|
+
* Classification code (BT-158).
|
|
23
|
+
*/
|
|
24
|
+
'class_code': string;
|
|
25
|
+
'list_id'?: string | null;
|
|
26
|
+
'list_version_id'?: string | null;
|
|
27
|
+
}
|
|
28
|
+
|
package/models/quantity.ts
CHANGED
package/models/recipient.ts
CHANGED
|
@@ -13,6 +13,9 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { Contact } from './contact';
|
|
16
19
|
// May contain unused imports in some cases
|
|
17
20
|
// @ts-ignore
|
|
18
21
|
import type { ElectronicAddress } from './electronic-address';
|
|
@@ -21,7 +24,7 @@ import type { ElectronicAddress } from './electronic-address';
|
|
|
21
24
|
import type { PostalAddress } from './postal-address';
|
|
22
25
|
|
|
23
26
|
/**
|
|
24
|
-
* Information about the invoice recipient (
|
|
27
|
+
* Information about the invoice recipient / buyer (BG-7).
|
|
25
28
|
*/
|
|
26
29
|
export interface Recipient {
|
|
27
30
|
'electronic_address': ElectronicAddress | null;
|
|
@@ -29,6 +32,9 @@ export interface Recipient {
|
|
|
29
32
|
'name'?: string | null;
|
|
30
33
|
'siren'?: string | null;
|
|
31
34
|
'siret'?: string | null;
|
|
35
|
+
'vat_number'?: string | null;
|
|
32
36
|
'postal_address'?: PostalAddress | null;
|
|
37
|
+
'contact'?: Contact | null;
|
|
38
|
+
'global_ids'?: Array<ElectronicAddress> | null;
|
|
33
39
|
}
|
|
34
40
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Rounding amount added to total (BT-114).
|
|
19
|
+
*/
|
|
20
|
+
export interface RoundingAmount {
|
|
21
|
+
}
|
|
22
|
+
|
package/models/scheme-id.ts
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
|
-
* Identification scheme codes (Electronic Address Scheme - EAS), mainly for electronic invoice addressing. **Possible values:** - `0225`: FR_SIREN - French SIREN (most common for France
|
|
18
|
+
* Identification scheme codes (Electronic Address Scheme - EAS), mainly for electronic invoice addressing. **Possible values:** - `0225`: FR_SIREN - French SIREN (most common for France) - `0009`: FR_SIRET - French SIRET - `0002`: FR_SIREN_OLD - French SIREN (old code, for legal organization ID) - `0088`: GLN - Global Location Number - `0060`: DUNS - Data Universal Numbering System - `9957`: FR_VAT_INTRA - French intra-community VAT number - `0199`: GLEIF - Global Legal Entity Identifier Foundation - `0231`: DT_DIRECTORY_ID - Directory ID for tax administration - `EM`: EMAIL - Email-based electronic address (BT-34/BT-49)
|
|
19
19
|
*/
|
|
20
20
|
|
|
21
21
|
export const SchemeID = {
|
|
@@ -26,19 +26,25 @@ export const SchemeID = {
|
|
|
26
26
|
/**
|
|
27
27
|
* GLN - Global Location Number (GLN)
|
|
28
28
|
*/
|
|
29
|
-
GLN: '
|
|
29
|
+
GLN: '0009',
|
|
30
30
|
/**
|
|
31
31
|
* DUNS - Data Universal Numbering System (DUNS)
|
|
32
32
|
*/
|
|
33
|
-
DUNS: '
|
|
33
|
+
DUNS: '0002',
|
|
34
34
|
/**
|
|
35
35
|
* FR_TVA_INTRA - French intra-community VAT number
|
|
36
36
|
*/
|
|
37
|
-
FR_TVA_INTRA: '
|
|
37
|
+
FR_TVA_INTRA: '0088',
|
|
38
38
|
/**
|
|
39
39
|
* GLEIF - Global Legal Entity Identifier Foundation (GLEIF)
|
|
40
40
|
*/
|
|
41
|
-
GLEIF: '
|
|
41
|
+
GLEIF: '0060',
|
|
42
|
+
_9957: '9957',
|
|
43
|
+
_0199: '0199',
|
|
44
|
+
_0231: '0231',
|
|
45
|
+
Em: 'EM',
|
|
46
|
+
_0177: '0177',
|
|
47
|
+
_0224: '0224'
|
|
42
48
|
} as const;
|
|
43
49
|
|
|
44
50
|
export type SchemeID = typeof SchemeID[keyof typeof SchemeID];
|
|
@@ -27,13 +27,13 @@ import type { FlowType } from './flow-type';
|
|
|
27
27
|
* Request to search submitted flows.
|
|
28
28
|
*/
|
|
29
29
|
export interface SearchFlowRequest {
|
|
30
|
-
'
|
|
31
|
-
'
|
|
32
|
-
'
|
|
33
|
-
'
|
|
34
|
-
'
|
|
35
|
-
'
|
|
36
|
-
'
|
|
30
|
+
'updatedAfter'?: string | null;
|
|
31
|
+
'updatedBefore'?: string | null;
|
|
32
|
+
'flowTypes'?: Array<FlowType> | null;
|
|
33
|
+
'flowDirections'?: Array<FlowDirection> | null;
|
|
34
|
+
'trackingId'?: string | null;
|
|
35
|
+
'flowId'?: string | null;
|
|
36
|
+
'acknowledgmentStatus'?: AcknowledgmentStatus | null;
|
|
37
37
|
/**
|
|
38
38
|
* Offset for pagination
|
|
39
39
|
*/
|
|
@@ -22,12 +22,12 @@ import type { FactureElectroniqueRestApiSchemasChorusProChorusProCredentials } f
|
|
|
22
22
|
*/
|
|
23
23
|
export interface SearchStructureRequest {
|
|
24
24
|
'credentials'?: FactureElectroniqueRestApiSchemasChorusProChorusProCredentials | null;
|
|
25
|
-
'
|
|
26
|
-
'
|
|
27
|
-
'
|
|
25
|
+
'structureIdentifier'?: string | null;
|
|
26
|
+
'structureIdentifierType'?: string | null;
|
|
27
|
+
'companyName'?: string | null;
|
|
28
28
|
/**
|
|
29
29
|
* Limit search to private structures only
|
|
30
30
|
*/
|
|
31
|
-
'
|
|
31
|
+
'restrictPrivateStructures'?: boolean;
|
|
32
32
|
}
|
|
33
33
|
|
|
@@ -30,15 +30,15 @@ export interface SubmitFlowRequest {
|
|
|
30
30
|
/**
|
|
31
31
|
* Flow name (e.g., \'Invoice 2025-001\')
|
|
32
32
|
*/
|
|
33
|
-
'
|
|
33
|
+
'flowName': string;
|
|
34
34
|
/**
|
|
35
35
|
* Flow syntax (CII for Factur-X)
|
|
36
36
|
*/
|
|
37
|
-
'
|
|
38
|
-
'
|
|
39
|
-
'
|
|
40
|
-
'
|
|
41
|
-
'
|
|
37
|
+
'flowSyntax'?: FlowSyntax;
|
|
38
|
+
'flowProfile'?: FlowProfile | null;
|
|
39
|
+
'trackingId'?: string | null;
|
|
40
|
+
'requestId'?: string | null;
|
|
41
|
+
'pdpCredentials'?: PDPCredentials | null;
|
|
42
42
|
}
|
|
43
43
|
|
|
44
44
|
|
|
@@ -34,25 +34,25 @@ export interface SubmitInvoiceRequest {
|
|
|
34
34
|
/**
|
|
35
35
|
* Invoice number
|
|
36
36
|
*/
|
|
37
|
-
'
|
|
37
|
+
'invoiceNumber': string;
|
|
38
38
|
/**
|
|
39
39
|
* Invoice date (ISO format: YYYY-MM-DD)
|
|
40
40
|
*/
|
|
41
|
-
'
|
|
42
|
-
'
|
|
41
|
+
'invoiceDate': string;
|
|
42
|
+
'paymentDueDate'?: string | null;
|
|
43
43
|
/**
|
|
44
44
|
* Chorus Pro recipient structure ID
|
|
45
45
|
*/
|
|
46
|
-
'
|
|
47
|
-
'
|
|
48
|
-
'
|
|
49
|
-
'
|
|
50
|
-
'
|
|
51
|
-
'
|
|
52
|
-
'
|
|
53
|
-
'
|
|
46
|
+
'structureId': number;
|
|
47
|
+
'serviceCode'?: string | null;
|
|
48
|
+
'engagementNumber'?: string | null;
|
|
49
|
+
'totalNetAmount': SubmitNetAmount;
|
|
50
|
+
'vatAmount': SubmitVatAmount;
|
|
51
|
+
'totalGrossAmount': SubmitGrossAmount;
|
|
52
|
+
'mainAttachmentId'?: number | null;
|
|
53
|
+
'mainAttachmentLabel'?: string | null;
|
|
54
54
|
'comment'?: string | null;
|
|
55
|
-
'
|
|
56
|
-
'
|
|
55
|
+
'purchaseOrderReference'?: string | null;
|
|
56
|
+
'contractReference'?: string | null;
|
|
57
57
|
}
|
|
58
58
|
|
package/models/supplier.ts
CHANGED
|
@@ -13,6 +13,9 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { Contact } from './contact';
|
|
16
19
|
// May contain unused imports in some cases
|
|
17
20
|
// @ts-ignore
|
|
18
21
|
import type { ElectronicAddress } from './electronic-address';
|
|
@@ -21,18 +24,26 @@ import type { ElectronicAddress } from './electronic-address';
|
|
|
21
24
|
import type { PostalAddress } from './postal-address';
|
|
22
25
|
|
|
23
26
|
/**
|
|
24
|
-
* Information about the supplier
|
|
27
|
+
* Information about the supplier / seller (BG-4).
|
|
25
28
|
*/
|
|
26
29
|
export interface Supplier {
|
|
27
30
|
'electronic_address': ElectronicAddress | null;
|
|
28
31
|
'supplier_id': number;
|
|
32
|
+
'private_id'?: string | null;
|
|
29
33
|
'supplier_bank_account_code'?: number | null;
|
|
30
34
|
'supplier_service_id'?: number | null;
|
|
31
35
|
'name'?: string | null;
|
|
36
|
+
'trading_business_name'?: string | null;
|
|
37
|
+
'legal_description'?: string | null;
|
|
32
38
|
'siren'?: string | null;
|
|
33
39
|
'siret'?: string | null;
|
|
34
40
|
'vat_number'?: string | null;
|
|
35
41
|
'iban'?: string | null;
|
|
42
|
+
'bic'?: string | null;
|
|
43
|
+
'bank_account_name'?: string | null;
|
|
44
|
+
'proprietaryId'?: string | null;
|
|
36
45
|
'postal_address'?: PostalAddress | null;
|
|
46
|
+
'contact'?: Contact | null;
|
|
47
|
+
'global_ids'?: Array<ElectronicAddress> | null;
|
|
37
48
|
}
|
|
38
49
|
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* FactPulse REST API
|
|
5
|
+
* REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { PostalAddress } from './postal-address';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Seller tax representative (BG-11). The tax representative is required when the seller is not established in the country where VAT is due.
|
|
22
|
+
*/
|
|
23
|
+
export interface TaxRepresentative {
|
|
24
|
+
/**
|
|
25
|
+
* Tax representative name (BT-62).
|
|
26
|
+
*/
|
|
27
|
+
'name': string;
|
|
28
|
+
/**
|
|
29
|
+
* Tax representative VAT identifier (BT-63).
|
|
30
|
+
*/
|
|
31
|
+
'vat_number': string;
|
|
32
|
+
/**
|
|
33
|
+
* Tax representative postal address (BG-12).
|
|
34
|
+
*/
|
|
35
|
+
'postal_address': PostalAddress;
|
|
36
|
+
}
|
|
37
|
+
|
package/models/taxable-amount.ts
CHANGED