@factpulse/sdk 3.0.37 → 4.0.1
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 +32 -8
- package/.openapi-generator/VERSION +1 -1
- package/CHANGELOG.md +5 -12
- package/README.md +135 -148
- package/api/cdarcycle-de-vie-api.ts +186 -86
- package/api/client-management-api.ts +672 -0
- package/api/downloads-api.ts +0 -152
- package/api/invoice-processing-api.ts +2 -2
- package/api.ts +1 -0
- package/dist/api/cdarcycle-de-vie-api.d.ts +93 -50
- package/dist/api/cdarcycle-de-vie-api.js +174 -80
- package/dist/api/client-management-api.d.ts +309 -0
- package/dist/api/client-management-api.js +642 -0
- package/dist/api/downloads-api.d.ts +0 -68
- package/dist/api/downloads-api.js +0 -145
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/esm/api/cdarcycle-de-vie-api.d.ts +93 -50
- package/dist/esm/api/cdarcycle-de-vie-api.js +174 -80
- package/dist/esm/api/client-management-api.d.ts +309 -0
- package/dist/esm/api/client-management-api.js +632 -0
- package/dist/esm/api/downloads-api.d.ts +0 -68
- package/dist/esm/api/downloads-api.js +0 -145
- package/dist/esm/api.d.ts +1 -0
- package/dist/esm/api.js +1 -0
- package/dist/esm/models/allowance-charge.d.ts +2 -2
- package/dist/esm/models/amount.d.ts +1 -1
- package/dist/esm/models/amount1.d.ts +1 -1
- package/dist/esm/models/amount2.d.ts +16 -0
- package/dist/esm/models/chorus-pro-credentials.d.ts +19 -7
- package/dist/esm/models/chorus-pro-destination.d.ts +2 -2
- package/dist/esm/models/{body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts → client-activate-response.d.ts} +16 -5
- package/dist/esm/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts → client-create-request.d.ts} +6 -4
- package/dist/esm/models/client-detail.d.ts +48 -0
- package/dist/esm/models/client-list-response.d.ts +33 -0
- package/dist/esm/models/client-list-response.js +14 -0
- package/dist/esm/models/client-summary.d.ts +48 -0
- package/dist/esm/models/client-summary.js +14 -0
- package/dist/esm/models/client-update-request.d.ts +19 -0
- package/dist/esm/models/client-update-request.js +14 -0
- package/dist/esm/models/encaissee-request.d.ts +39 -0
- package/dist/esm/models/encaissee-request.js +14 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-cdar-validation-error-response.d.ts +29 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-cdar-validation-error-response.js +14 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts +24 -0
- package/dist/esm/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js +14 -0
- package/dist/esm/models/get-chorus-pro-id-request.d.ts +2 -2
- package/dist/esm/models/get-invoice-request.d.ts +2 -2
- package/dist/esm/models/get-structure-request.d.ts +2 -2
- package/dist/esm/models/index.d.ts +15 -4
- package/dist/esm/models/index.js +15 -4
- package/dist/esm/models/payment-amount-by-rate.d.ts +2 -2
- package/dist/esm/models/pdpconfig-response.d.ts +34 -0
- package/dist/esm/models/pdpconfig-response.js +14 -0
- package/dist/esm/models/pdpconfig-update-request.d.ts +40 -0
- package/dist/esm/models/pdpconfig-update-request.js +14 -0
- package/dist/esm/models/recipient.d.ts +1 -1
- package/dist/{models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts → esm/models/refusee-request.d.ts} +16 -14
- package/dist/esm/models/refusee-request.js +14 -0
- package/dist/esm/models/scheme-id.d.ts +7 -7
- package/dist/esm/models/scheme-id.js +7 -7
- package/dist/esm/models/search-structure-request.d.ts +2 -2
- package/dist/esm/models/{body-submit-cdar-api-v1-cdar-submit-post.d.ts → secret-status.d.ts} +12 -5
- package/dist/esm/models/secret-status.js +14 -0
- package/dist/esm/models/simplified-cdarresponse.d.ts +36 -0
- package/dist/esm/models/simplified-cdarresponse.js +14 -0
- package/dist/esm/models/submit-cdarrequest.d.ts +4 -0
- package/dist/esm/models/submit-cdarxmlrequest.d.ts +4 -0
- package/dist/esm/models/submit-complete-invoice-response.d.ts +1 -1
- package/dist/esm/models/submit-invoice-request.d.ts +2 -2
- package/dist/esm/models/supplier.d.ts +1 -1
- package/dist/esm/models/validate-cdarresponse.d.ts +3 -3
- package/dist/esm/models/validation-error-response.d.ts +3 -12
- package/dist/esm/src/helpers/client.d.ts +45 -265
- package/dist/esm/src/helpers/client.js +211 -773
- package/dist/esm/src/helpers/exceptions.d.ts +3 -1
- package/dist/esm/src/helpers/exceptions.js +7 -1
- package/dist/esm/src/helpers/index.d.ts +1 -2
- package/dist/esm/src/helpers/index.js +1 -3
- package/dist/models/allowance-charge.d.ts +2 -2
- package/dist/models/amount.d.ts +1 -1
- package/dist/models/amount1.d.ts +1 -1
- package/dist/models/amount2.d.ts +16 -0
- package/dist/models/chorus-pro-credentials.d.ts +19 -7
- package/dist/models/chorus-pro-destination.d.ts +2 -2
- package/dist/models/client-activate-response.d.ts +28 -0
- package/dist/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts → client-create-request.d.ts} +6 -4
- package/dist/models/client-detail.d.ts +48 -0
- package/dist/models/client-list-response.d.ts +33 -0
- package/dist/models/client-list-response.js +15 -0
- package/dist/models/client-summary.d.ts +48 -0
- package/dist/models/client-summary.js +15 -0
- package/dist/models/client-update-request.d.ts +19 -0
- package/dist/models/client-update-request.js +15 -0
- package/dist/models/encaissee-request.d.ts +39 -0
- package/dist/models/encaissee-request.js +15 -0
- package/dist/models/facture-electronique-rest-api-schemas-cdar-validation-error-response.d.ts +29 -0
- package/dist/models/facture-electronique-rest-api-schemas-cdar-validation-error-response.js +15 -0
- package/dist/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts +24 -0
- package/dist/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js +15 -0
- package/dist/models/get-chorus-pro-id-request.d.ts +2 -2
- package/dist/models/get-invoice-request.d.ts +2 -2
- package/dist/models/get-structure-request.d.ts +2 -2
- package/dist/models/index.d.ts +15 -4
- package/dist/models/index.js +15 -4
- package/dist/models/payment-amount-by-rate.d.ts +2 -2
- package/dist/models/pdpconfig-response.d.ts +34 -0
- package/dist/models/pdpconfig-response.js +15 -0
- package/dist/models/pdpconfig-update-request.d.ts +40 -0
- package/dist/models/pdpconfig-update-request.js +15 -0
- package/dist/models/recipient.d.ts +1 -1
- package/dist/{esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts → models/refusee-request.d.ts} +16 -14
- package/dist/models/refusee-request.js +15 -0
- package/dist/models/scheme-id.d.ts +7 -7
- package/dist/models/scheme-id.js +7 -7
- package/dist/models/search-structure-request.d.ts +2 -2
- package/dist/models/{body-submit-cdar-api-v1-cdar-submit-post.d.ts → secret-status.d.ts} +12 -5
- package/dist/models/secret-status.js +15 -0
- package/dist/models/simplified-cdarresponse.d.ts +36 -0
- package/dist/models/simplified-cdarresponse.js +15 -0
- package/dist/models/submit-cdarrequest.d.ts +4 -0
- package/dist/models/submit-cdarxmlrequest.d.ts +4 -0
- package/dist/models/submit-complete-invoice-response.d.ts +1 -1
- package/dist/models/submit-invoice-request.d.ts +2 -2
- package/dist/models/supplier.d.ts +1 -1
- package/dist/models/validate-cdarresponse.d.ts +3 -3
- package/dist/models/validation-error-response.d.ts +3 -12
- package/dist/src/helpers/client.d.ts +45 -265
- package/dist/src/helpers/client.js +214 -784
- package/dist/src/helpers/exceptions.d.ts +3 -1
- package/dist/src/helpers/exceptions.js +7 -1
- package/dist/src/helpers/index.d.ts +1 -2
- package/dist/src/helpers/index.js +2 -12
- package/docs/AllowanceCharge.md +1 -1
- package/docs/Amount.md +1 -1
- package/docs/Amount1.md +1 -1
- package/docs/Amount2.md +19 -0
- package/docs/CDARCycleDeVieApi.md +126 -30
- package/docs/ChorusProCredentials.md +9 -9
- package/docs/ChorusProDestination.md +1 -1
- package/docs/ClientActivateResponse.md +25 -0
- package/docs/ClientCreateRequest.md +25 -0
- package/docs/ClientDetail.md +41 -0
- package/docs/ClientListResponse.md +27 -0
- package/docs/ClientManagementApi.md +483 -0
- package/docs/ClientSummary.md +41 -0
- package/docs/ClientUpdateRequest.md +25 -0
- package/docs/DownloadsApi.md +0 -115
- package/docs/EncaisseeRequest.md +39 -0
- package/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +27 -0
- package/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +29 -0
- package/docs/GetChorusProIdRequest.md +1 -1
- package/docs/GetInvoiceRequest.md +1 -1
- package/docs/GetStructureRequest.md +1 -1
- package/docs/PDPConfigResponse.md +47 -0
- package/docs/PDPConfigUpdateRequest.md +31 -0
- package/docs/PaymentAmountByRate.md +1 -1
- package/docs/Recipient.md +1 -1
- package/docs/RefuseeRequest.md +39 -0
- package/docs/SchemeID.md +4 -4
- package/docs/SearchStructureRequest.md +1 -1
- package/docs/SecretStatus.md +23 -0
- package/docs/SimplifiedCDARResponse.md +29 -0
- package/docs/SubmitCDARRequest.md +8 -0
- package/docs/SubmitCDARXMLRequest.md +8 -0
- package/docs/SubmitCompleteInvoiceResponse.md +2 -2
- package/docs/SubmitInvoiceRequest.md +1 -1
- package/docs/Supplier.md +1 -1
- package/docs/ValidateCDARResponse.md +2 -2
- package/docs/ValidationErrorResponse.md +3 -9
- package/models/allowance-charge.ts +2 -2
- package/models/amount.ts +1 -1
- package/models/amount1.ts +1 -1
- package/models/amount2.ts +22 -0
- package/models/chorus-pro-credentials.ts +19 -7
- package/models/chorus-pro-destination.ts +2 -2
- package/models/client-activate-response.ts +34 -0
- package/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.ts → client-create-request.ts} +6 -4
- package/models/client-detail.ts +54 -0
- package/models/{body-submit-cdar-xml-api-v1-cdar-submit-xml-post.ts → client-list-response.ts} +21 -7
- package/models/client-summary.ts +54 -0
- package/models/client-update-request.ts +25 -0
- package/models/{facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.ts → encaissee-request.ts} +19 -14
- package/models/{body-submit-cdar-api-v1-cdar-submit-post.ts → facture-electronique-rest-api-schemas-cdar-validation-error-response.ts} +17 -9
- package/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.ts +30 -0
- package/models/get-chorus-pro-id-request.ts +2 -2
- package/models/get-invoice-request.ts +2 -2
- package/models/get-structure-request.ts +2 -2
- package/models/index.ts +15 -4
- package/models/payment-amount-by-rate.ts +2 -2
- package/models/pdpconfig-response.ts +42 -0
- package/models/pdpconfig-update-request.ts +46 -0
- package/models/recipient.ts +1 -1
- package/models/refusee-request.ts +44 -0
- package/models/scheme-id.ts +7 -7
- package/models/search-structure-request.ts +2 -2
- package/models/secret-status.ts +30 -0
- package/models/simplified-cdarresponse.ts +42 -0
- package/models/submit-cdarrequest.ts +4 -0
- package/models/submit-cdarxmlrequest.ts +4 -0
- package/models/submit-complete-invoice-response.ts +1 -1
- package/models/submit-invoice-request.ts +2 -2
- package/models/supplier.ts +1 -1
- package/models/validate-cdarresponse.ts +3 -3
- package/models/validation-error-response.ts +3 -12
- package/package.json +1 -1
- package/src/helpers/client.ts +227 -832
- package/src/helpers/exceptions.ts +9 -1
- package/src/helpers/index.ts +1 -3
- package/dist/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts +0 -17
- package/docs/BodySubmitCdarApiV1CdarSubmitPost.md +0 -22
- package/docs/BodySubmitCdarXmlApiV1CdarSubmitXmlPost.md +0 -22
- package/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +0 -29
- package/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +0 -21
- /package/dist/esm/models/{body-submit-cdar-api-v1-cdar-submit-post.js → amount2.js} +0 -0
- /package/dist/esm/models/{body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js → client-activate-response.js} +0 -0
- /package/dist/esm/models/{facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js → client-create-request.js} +0 -0
- /package/dist/esm/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.js → client-detail.js} +0 -0
- /package/dist/models/{body-submit-cdar-api-v1-cdar-submit-post.js → amount2.js} +0 -0
- /package/dist/models/{body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js → client-activate-response.js} +0 -0
- /package/dist/models/{facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js → client-create-request.js} +0 -0
- /package/dist/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.js → client-detail.js} +0 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* FactPulse REST API
|
|
6
|
+
* 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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: contact@factpulse.fr
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FactPulse REST API
|
|
3
|
+
* 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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: contact@factpulse.fr
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Optional Chorus Pro credentials. **MODE 1 - JWT retrieval (recommended):** Do not provide this `credentials` field in the payload. Credentials will be automatically retrieved via client_uid from JWT (0-trust). **MODE 2 - Credentials in payload:** Provide all required fields below. Useful for tests or third-party integrations.
|
|
14
|
+
*/
|
|
15
|
+
export interface FactureElectroniqueRestApiSchemasProcessingChorusProCredentials {
|
|
16
|
+
'pisteClientId'?: string | null;
|
|
17
|
+
'pisteClientSecret'?: string | null;
|
|
18
|
+
'chorusLogin'?: string | null;
|
|
19
|
+
'chorusPassword'?: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* [MODE 2] Use sandbox mode (default: True)
|
|
22
|
+
*/
|
|
23
|
+
'sandboxMode'?: boolean;
|
|
24
|
+
}
|
package/dist/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* FactPulse REST API
|
|
6
|
+
* 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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: contact@factpulse.fr
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { ChorusProCredentials } from './chorus-pro-credentials';
|
|
13
13
|
/**
|
|
14
14
|
* Get Chorus Pro ID from SIRET.
|
|
15
15
|
*/
|
|
16
16
|
export interface GetChorusProIdRequest {
|
|
17
|
-
'credentials'?:
|
|
17
|
+
'credentials'?: ChorusProCredentials | null;
|
|
18
18
|
/**
|
|
19
19
|
* Structure SIRET (14 digits)
|
|
20
20
|
*/
|
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { ChorusProCredentials } from './chorus-pro-credentials';
|
|
13
13
|
/**
|
|
14
14
|
* Get an invoice.
|
|
15
15
|
*/
|
|
16
16
|
export interface GetInvoiceRequest {
|
|
17
|
-
'credentials'?:
|
|
17
|
+
'credentials'?: ChorusProCredentials | null;
|
|
18
18
|
/**
|
|
19
19
|
* Chorus Pro invoice ID
|
|
20
20
|
*/
|
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { ChorusProCredentials } from './chorus-pro-credentials';
|
|
13
13
|
/**
|
|
14
14
|
* Get structure details.
|
|
15
15
|
*/
|
|
16
16
|
export interface GetStructureRequest {
|
|
17
|
-
'credentials'?:
|
|
17
|
+
'credentials'?: ChorusProCredentials | null;
|
|
18
18
|
/**
|
|
19
19
|
* Chorus Pro structure ID
|
|
20
20
|
*/
|
package/dist/models/index.d.ts
CHANGED
|
@@ -107,11 +107,10 @@ export * from './allowance-reason-code';
|
|
|
107
107
|
export * from './allowance-total-amount';
|
|
108
108
|
export * from './amount';
|
|
109
109
|
export * from './amount1';
|
|
110
|
+
export * from './amount2';
|
|
110
111
|
export * from './amount-due';
|
|
111
112
|
export * from './async-task-status';
|
|
112
113
|
export * from './base-amount';
|
|
113
|
-
export * from './body-submit-cdar-api-v1-cdar-submit-post';
|
|
114
|
-
export * from './body-submit-cdar-xml-api-v1-cdar-submit-xml-post';
|
|
115
114
|
export * from './bounding-box-schema';
|
|
116
115
|
export * from './buyercountry';
|
|
117
116
|
export * from './celery-status';
|
|
@@ -120,6 +119,12 @@ export * from './charge-total-amount';
|
|
|
120
119
|
export * from './chorus-pro-credentials';
|
|
121
120
|
export * from './chorus-pro-destination';
|
|
122
121
|
export * from './chorus-pro-result';
|
|
122
|
+
export * from './client-activate-response';
|
|
123
|
+
export * from './client-create-request';
|
|
124
|
+
export * from './client-detail';
|
|
125
|
+
export * from './client-list-response';
|
|
126
|
+
export * from './client-summary';
|
|
127
|
+
export * from './client-update-request';
|
|
123
128
|
export * from './contact';
|
|
124
129
|
export * from './convert-resume-request';
|
|
125
130
|
export * from './convert-success-response';
|
|
@@ -139,15 +144,16 @@ export * from './ereporting-validation-error';
|
|
|
139
144
|
export * from './electronic-address';
|
|
140
145
|
export * from './encaisseamount';
|
|
141
146
|
export * from './encaisseamount1';
|
|
147
|
+
export * from './encaissee-request';
|
|
142
148
|
export * from './enriched-invoice-info';
|
|
143
149
|
export * from './error-level';
|
|
144
150
|
export * from './error-source';
|
|
145
151
|
export * from './extraction-info';
|
|
146
152
|
export * from './factur-xinvoice';
|
|
147
153
|
export * from './factur-xpdfinfo';
|
|
148
|
-
export * from './facture-electronique-rest-api-schemas-
|
|
154
|
+
export * from './facture-electronique-rest-api-schemas-cdar-validation-error-response';
|
|
149
155
|
export * from './facture-electronique-rest-api-schemas-ereporting-invoice-type-code';
|
|
150
|
-
export * from './facture-electronique-rest-api-schemas-
|
|
156
|
+
export * from './facture-electronique-rest-api-schemas-processing-chorus-pro-credentials';
|
|
151
157
|
export * from './field-status';
|
|
152
158
|
export * from './file-info';
|
|
153
159
|
export * from './files-info';
|
|
@@ -197,6 +203,8 @@ export * from './missing-field';
|
|
|
197
203
|
export * from './operation-nature';
|
|
198
204
|
export * from './output-format';
|
|
199
205
|
export * from './pdfvalidation-result-api';
|
|
206
|
+
export * from './pdpconfig-response';
|
|
207
|
+
export * from './pdpconfig-update-request';
|
|
200
208
|
export * from './pdpcredentials';
|
|
201
209
|
export * from './page-dimensions-schema';
|
|
202
210
|
export * from './payee';
|
|
@@ -218,6 +226,7 @@ export * from './reason-code-info';
|
|
|
218
226
|
export * from './reason-codes-response';
|
|
219
227
|
export * from './recipient';
|
|
220
228
|
export * from './recipient-input';
|
|
229
|
+
export * from './refusee-request';
|
|
221
230
|
export * from './report-period';
|
|
222
231
|
export * from './report-sender';
|
|
223
232
|
export * from './rounding-amount';
|
|
@@ -228,10 +237,12 @@ export * from './search-flow-response';
|
|
|
228
237
|
export * from './search-services-response';
|
|
229
238
|
export * from './search-structure-request';
|
|
230
239
|
export * from './search-structure-response';
|
|
240
|
+
export * from './secret-status';
|
|
231
241
|
export * from './sellercountry';
|
|
232
242
|
export * from './signature-info';
|
|
233
243
|
export * from './signature-info-api';
|
|
234
244
|
export * from './signature-parameters';
|
|
245
|
+
export * from './simplified-cdarresponse';
|
|
235
246
|
export * from './simplified-invoice-data';
|
|
236
247
|
export * from './status-code-info';
|
|
237
248
|
export * from './status-codes-response';
|
package/dist/models/index.js
CHANGED
|
@@ -123,11 +123,10 @@ __exportStar(require("./allowance-reason-code"), exports);
|
|
|
123
123
|
__exportStar(require("./allowance-total-amount"), exports);
|
|
124
124
|
__exportStar(require("./amount"), exports);
|
|
125
125
|
__exportStar(require("./amount1"), exports);
|
|
126
|
+
__exportStar(require("./amount2"), exports);
|
|
126
127
|
__exportStar(require("./amount-due"), exports);
|
|
127
128
|
__exportStar(require("./async-task-status"), exports);
|
|
128
129
|
__exportStar(require("./base-amount"), exports);
|
|
129
|
-
__exportStar(require("./body-submit-cdar-api-v1-cdar-submit-post"), exports);
|
|
130
|
-
__exportStar(require("./body-submit-cdar-xml-api-v1-cdar-submit-xml-post"), exports);
|
|
131
130
|
__exportStar(require("./bounding-box-schema"), exports);
|
|
132
131
|
__exportStar(require("./buyercountry"), exports);
|
|
133
132
|
__exportStar(require("./celery-status"), exports);
|
|
@@ -136,6 +135,12 @@ __exportStar(require("./charge-total-amount"), exports);
|
|
|
136
135
|
__exportStar(require("./chorus-pro-credentials"), exports);
|
|
137
136
|
__exportStar(require("./chorus-pro-destination"), exports);
|
|
138
137
|
__exportStar(require("./chorus-pro-result"), exports);
|
|
138
|
+
__exportStar(require("./client-activate-response"), exports);
|
|
139
|
+
__exportStar(require("./client-create-request"), exports);
|
|
140
|
+
__exportStar(require("./client-detail"), exports);
|
|
141
|
+
__exportStar(require("./client-list-response"), exports);
|
|
142
|
+
__exportStar(require("./client-summary"), exports);
|
|
143
|
+
__exportStar(require("./client-update-request"), exports);
|
|
139
144
|
__exportStar(require("./contact"), exports);
|
|
140
145
|
__exportStar(require("./convert-resume-request"), exports);
|
|
141
146
|
__exportStar(require("./convert-success-response"), exports);
|
|
@@ -155,15 +160,16 @@ __exportStar(require("./ereporting-validation-error"), exports);
|
|
|
155
160
|
__exportStar(require("./electronic-address"), exports);
|
|
156
161
|
__exportStar(require("./encaisseamount"), exports);
|
|
157
162
|
__exportStar(require("./encaisseamount1"), exports);
|
|
163
|
+
__exportStar(require("./encaissee-request"), exports);
|
|
158
164
|
__exportStar(require("./enriched-invoice-info"), exports);
|
|
159
165
|
__exportStar(require("./error-level"), exports);
|
|
160
166
|
__exportStar(require("./error-source"), exports);
|
|
161
167
|
__exportStar(require("./extraction-info"), exports);
|
|
162
168
|
__exportStar(require("./factur-xinvoice"), exports);
|
|
163
169
|
__exportStar(require("./factur-xpdfinfo"), exports);
|
|
164
|
-
__exportStar(require("./facture-electronique-rest-api-schemas-
|
|
170
|
+
__exportStar(require("./facture-electronique-rest-api-schemas-cdar-validation-error-response"), exports);
|
|
165
171
|
__exportStar(require("./facture-electronique-rest-api-schemas-ereporting-invoice-type-code"), exports);
|
|
166
|
-
__exportStar(require("./facture-electronique-rest-api-schemas-
|
|
172
|
+
__exportStar(require("./facture-electronique-rest-api-schemas-processing-chorus-pro-credentials"), exports);
|
|
167
173
|
__exportStar(require("./field-status"), exports);
|
|
168
174
|
__exportStar(require("./file-info"), exports);
|
|
169
175
|
__exportStar(require("./files-info"), exports);
|
|
@@ -213,6 +219,8 @@ __exportStar(require("./missing-field"), exports);
|
|
|
213
219
|
__exportStar(require("./operation-nature"), exports);
|
|
214
220
|
__exportStar(require("./output-format"), exports);
|
|
215
221
|
__exportStar(require("./pdfvalidation-result-api"), exports);
|
|
222
|
+
__exportStar(require("./pdpconfig-response"), exports);
|
|
223
|
+
__exportStar(require("./pdpconfig-update-request"), exports);
|
|
216
224
|
__exportStar(require("./pdpcredentials"), exports);
|
|
217
225
|
__exportStar(require("./page-dimensions-schema"), exports);
|
|
218
226
|
__exportStar(require("./payee"), exports);
|
|
@@ -234,6 +242,7 @@ __exportStar(require("./reason-code-info"), exports);
|
|
|
234
242
|
__exportStar(require("./reason-codes-response"), exports);
|
|
235
243
|
__exportStar(require("./recipient"), exports);
|
|
236
244
|
__exportStar(require("./recipient-input"), exports);
|
|
245
|
+
__exportStar(require("./refusee-request"), exports);
|
|
237
246
|
__exportStar(require("./report-period"), exports);
|
|
238
247
|
__exportStar(require("./report-sender"), exports);
|
|
239
248
|
__exportStar(require("./rounding-amount"), exports);
|
|
@@ -244,10 +253,12 @@ __exportStar(require("./search-flow-response"), exports);
|
|
|
244
253
|
__exportStar(require("./search-services-response"), exports);
|
|
245
254
|
__exportStar(require("./search-structure-request"), exports);
|
|
246
255
|
__exportStar(require("./search-structure-response"), exports);
|
|
256
|
+
__exportStar(require("./secret-status"), exports);
|
|
247
257
|
__exportStar(require("./sellercountry"), exports);
|
|
248
258
|
__exportStar(require("./signature-info"), exports);
|
|
249
259
|
__exportStar(require("./signature-info-api"), exports);
|
|
250
260
|
__exportStar(require("./signature-parameters"), exports);
|
|
261
|
+
__exportStar(require("./simplified-cdarresponse"), exports);
|
|
251
262
|
__exportStar(require("./simplified-invoice-data"), exports);
|
|
252
263
|
__exportStar(require("./status-code-info"), exports);
|
|
253
264
|
__exportStar(require("./status-codes-response"), exports);
|
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { Amount1 } from './amount1';
|
|
13
13
|
import type { Rate } from './rate';
|
|
14
14
|
/**
|
|
15
15
|
* Payment amount for a specific VAT rate.
|
|
16
16
|
*/
|
|
17
17
|
export interface PaymentAmountByRate {
|
|
18
18
|
'rate': Rate;
|
|
19
|
-
'amount':
|
|
19
|
+
'amount': Amount1;
|
|
20
20
|
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FactPulse REST API
|
|
3
|
+
* 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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: contact@factpulse.fr
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { SecretStatus } from './secret-status';
|
|
13
|
+
/**
|
|
14
|
+
* PDP configuration (secrets masked).
|
|
15
|
+
*/
|
|
16
|
+
export interface PDPConfigResponse {
|
|
17
|
+
/**
|
|
18
|
+
* Whether PDP config exists
|
|
19
|
+
*/
|
|
20
|
+
'isConfigured': boolean;
|
|
21
|
+
'id'?: number | null;
|
|
22
|
+
'isActive'?: boolean | null;
|
|
23
|
+
'modeSandbox'?: boolean | null;
|
|
24
|
+
'flowServiceUrl'?: string | null;
|
|
25
|
+
'tokenUrl'?: string | null;
|
|
26
|
+
'oauthClientId'?: string | null;
|
|
27
|
+
'secretStatus'?: SecretStatus | null;
|
|
28
|
+
'lastTestAt'?: string | null;
|
|
29
|
+
'lastTestSuccess'?: boolean | null;
|
|
30
|
+
'lastTestError'?: string | null;
|
|
31
|
+
'createdAt'?: string | null;
|
|
32
|
+
'updatedAt'?: string | null;
|
|
33
|
+
'message'?: string | null;
|
|
34
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* FactPulse REST API
|
|
6
|
+
* 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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: contact@factpulse.fr
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FactPulse REST API
|
|
3
|
+
* 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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: contact@factpulse.fr
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* PDP configuration update request.
|
|
14
|
+
*/
|
|
15
|
+
export interface PDPConfigUpdateRequest {
|
|
16
|
+
/**
|
|
17
|
+
* Whether config is active
|
|
18
|
+
*/
|
|
19
|
+
'isActive'?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Sandbox mode
|
|
22
|
+
*/
|
|
23
|
+
'modeSandbox'?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* PDP Flow Service URL
|
|
26
|
+
*/
|
|
27
|
+
'flowServiceUrl': string;
|
|
28
|
+
/**
|
|
29
|
+
* PDP OAuth token URL
|
|
30
|
+
*/
|
|
31
|
+
'tokenUrl': string;
|
|
32
|
+
/**
|
|
33
|
+
* OAuth Client ID
|
|
34
|
+
*/
|
|
35
|
+
'oauthClientId': string;
|
|
36
|
+
/**
|
|
37
|
+
* OAuth Client Secret (sent but never returned)
|
|
38
|
+
*/
|
|
39
|
+
'clientSecret': string;
|
|
40
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* FactPulse REST API
|
|
6
|
+
* 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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: contact@factpulse.fr
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -16,7 +16,7 @@ import type { PostalAddress } from './postal-address';
|
|
|
16
16
|
* Information about the invoice recipient / buyer (BG-7).
|
|
17
17
|
*/
|
|
18
18
|
export interface Recipient {
|
|
19
|
-
'electronic_address'
|
|
19
|
+
'electronic_address'?: ElectronicAddress | null;
|
|
20
20
|
'executing_service_code'?: string | null;
|
|
21
21
|
'name'?: string | null;
|
|
22
22
|
'siren'?: string | null;
|
|
@@ -10,27 +10,29 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Requête simplifiée pour soumettre un statut REFUSÉE (210). Statut obligatoire PPF - Le destinataire refuse la facture. Un code motif est OBLIGATOIRE (BR-FR-CDV-15). Codes motif autorisés (BR-FR-CDV-CL-09_MDT-113_210): - TX_TVA_ERR: Taux de TVA erroné - MONTANTTOTAL_ERR: Montant total erroné - CALCUL_ERR: Erreur de calcul - NON_CONFORME: Non conforme - DOUBLON: Doublon - DEST_ERR: Destinataire erroné - TRANSAC_INC: Transaction incomplète - EMMET_INC: Émetteur inconnu - CONTRAT_TERM: Contrat terminé - DOUBLE_FACT: Double facturation - CMD_ERR: Commande erronée - ADR_ERR: Adresse erronée - REF_CT_ABSENT: Référence contrat absente
|
|
14
14
|
*/
|
|
15
|
-
export interface
|
|
15
|
+
export interface RefuseeRequest {
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Identifiant de la facture (BT-1)
|
|
18
18
|
*/
|
|
19
|
-
'
|
|
19
|
+
'invoiceId': string;
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Date d\'émission de la facture (YYYY-MM-DD)
|
|
22
22
|
*/
|
|
23
|
-
'
|
|
23
|
+
'invoiceIssueDate': string;
|
|
24
|
+
'senderSiren'?: string | null;
|
|
24
25
|
/**
|
|
25
|
-
*
|
|
26
|
+
* Type de flux: SupplierInvoiceLC (acheteur) ou CustomerInvoiceLC (vendeur)
|
|
26
27
|
*/
|
|
27
|
-
'
|
|
28
|
+
'flowType'?: string;
|
|
29
|
+
'pdpFlowServiceUrl'?: string | null;
|
|
30
|
+
'pdpTokenUrl'?: string | null;
|
|
31
|
+
'pdpClientId'?: string | null;
|
|
32
|
+
'pdpClientSecret'?: string | null;
|
|
28
33
|
/**
|
|
29
|
-
*
|
|
34
|
+
* Code motif du refus (obligatoire). Valeurs autorisées: TX_TVA_ERR, MONTANTTOTAL_ERR, CALCUL_ERR, NON_CONFORME, DOUBLON, DEST_ERR, TRANSAC_INC, EMMET_INC, CONTRAT_TERM, DOUBLE_FACT, CMD_ERR, ADR_ERR, REF_CT_ABSENT
|
|
30
35
|
*/
|
|
31
|
-
'
|
|
32
|
-
|
|
33
|
-
* Use sandbox environment (true) or production (false)
|
|
34
|
-
*/
|
|
35
|
-
'sandbox'?: boolean;
|
|
36
|
+
'reasonCode': string;
|
|
37
|
+
'reasonText'?: string | null;
|
|
36
38
|
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* FactPulse REST API
|
|
6
|
+
* 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://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://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://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://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://factpulse.fr/api/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://factpulse.fr/documentation-api/
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
* Contact: contact@factpulse.fr
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -10,21 +10,21 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Identification scheme codes (Electronic Address Scheme - EAS)
|
|
13
|
+
* Identification scheme codes (Electronic Address Scheme - EAS). **Electronic Address (routing for PDP/Chorus Pro):** - `0225`: FR_ELECTRONIC_ADDRESS - French electronic billing address (BT-34/BT-49) Format: SIREN or SIREN_SUFFIX (e.g., \"920195229_92019522900017\") **Legal Identifiers (entity identification):** - `0002`: FR_SIREN - French SIREN (9 digits) for BT-30/BT-47 - `0009`: FR_SIRET - French SIRET (14 digits) for BT-29/BT-46 **Other schemes:** - `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
|
|
14
14
|
*/
|
|
15
15
|
export declare const SchemeID: {
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* FR_ELECTRONIC_ADDRESS - French electronic billing address (BT-34/BT-49)
|
|
18
18
|
*/
|
|
19
|
-
readonly
|
|
19
|
+
readonly FR_ELECTRONIC_ADDRESS: "0225";
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* FR_SIREN - French SIREN (9 digits) - Legal organization ID
|
|
22
22
|
*/
|
|
23
|
-
readonly
|
|
23
|
+
readonly FR_SIREN: "0002";
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* FR_SIRET - French SIRET (14 digits) - Establishment ID
|
|
26
26
|
*/
|
|
27
|
-
readonly
|
|
27
|
+
readonly FR_SIRET: "0009";
|
|
28
28
|
/**
|
|
29
29
|
* GLN - Global Location Number (GLN)
|
|
30
30
|
*/
|
package/dist/models/scheme-id.js
CHANGED
|
@@ -15,21 +15,21 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.SchemeID = void 0;
|
|
17
17
|
/**
|
|
18
|
-
* Identification scheme codes (Electronic Address Scheme - EAS)
|
|
18
|
+
* Identification scheme codes (Electronic Address Scheme - EAS). **Electronic Address (routing for PDP/Chorus Pro):** - `0225`: FR_ELECTRONIC_ADDRESS - French electronic billing address (BT-34/BT-49) Format: SIREN or SIREN_SUFFIX (e.g., \"920195229_92019522900017\") **Legal Identifiers (entity identification):** - `0002`: FR_SIREN - French SIREN (9 digits) for BT-30/BT-47 - `0009`: FR_SIRET - French SIRET (14 digits) for BT-29/BT-46 **Other schemes:** - `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
|
|
19
19
|
*/
|
|
20
20
|
exports.SchemeID = {
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* FR_ELECTRONIC_ADDRESS - French electronic billing address (BT-34/BT-49)
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
FR_ELECTRONIC_ADDRESS: '0225',
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* FR_SIREN - French SIREN (9 digits) - Legal organization ID
|
|
27
27
|
*/
|
|
28
|
-
|
|
28
|
+
FR_SIREN: '0002',
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* FR_SIRET - French SIRET (14 digits) - Establishment ID
|
|
31
31
|
*/
|
|
32
|
-
|
|
32
|
+
FR_SIRET: '0009',
|
|
33
33
|
/**
|
|
34
34
|
* GLN - Global Location Number (GLN)
|
|
35
35
|
*/
|
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type {
|
|
12
|
+
import type { ChorusProCredentials } from './chorus-pro-credentials';
|
|
13
13
|
/**
|
|
14
14
|
* Search structures by criteria.
|
|
15
15
|
*/
|
|
16
16
|
export interface SearchStructureRequest {
|
|
17
|
-
'credentials'?:
|
|
17
|
+
'credentials'?: ChorusProCredentials | null;
|
|
18
18
|
'structureIdentifier'?: string | null;
|
|
19
19
|
'structureIdentifierType'?: string | null;
|
|
20
20
|
'companyName'?: string | null;
|