@factpulse/sdk 3.0.18 → 3.0.23

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.
Files changed (54) hide show
  1. package/.openapi-generator/FILES +6 -4
  2. package/CHANGELOG.md +3 -3
  3. package/dist/esm/models/ereporting-validation-error.d.ts +25 -0
  4. package/dist/esm/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.d.ts +22 -0
  5. package/dist/esm/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.js +23 -0
  6. package/dist/esm/models/index.d.ts +3 -2
  7. package/dist/esm/models/index.js +3 -2
  8. package/dist/esm/models/invoice-input.d.ts +2 -2
  9. package/dist/esm/models/invoice-type-code.d.ts +65 -6
  10. package/dist/esm/models/invoice-type-code.js +65 -6
  11. package/dist/{models/facture-electronique-rest-api-schemas-convert-validation-error.d.ts → esm/models/schematron-validation-error.d.ts} +1 -1
  12. package/dist/esm/models/schematron-validation-error.js +14 -0
  13. package/dist/esm/models/simplified-invoice-data.d.ts +2 -2
  14. package/dist/esm/models/validate-ereporting-response.d.ts +3 -3
  15. package/dist/esm/models/validation-info.d.ts +2 -2
  16. package/dist/models/ereporting-validation-error.d.ts +25 -0
  17. package/dist/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.d.ts +22 -0
  18. package/dist/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.js +26 -0
  19. package/dist/models/index.d.ts +3 -2
  20. package/dist/models/index.js +3 -2
  21. package/dist/models/invoice-input.d.ts +2 -2
  22. package/dist/models/invoice-type-code.d.ts +65 -6
  23. package/dist/models/invoice-type-code.js +65 -6
  24. package/dist/{esm/models/facture-electronique-rest-api-schemas-convert-validation-error.d.ts → models/schematron-validation-error.d.ts} +1 -1
  25. package/dist/models/schematron-validation-error.js +15 -0
  26. package/dist/models/simplified-invoice-data.d.ts +2 -2
  27. package/dist/models/validate-ereporting-response.d.ts +3 -3
  28. package/dist/models/validation-info.d.ts +2 -2
  29. package/docs/EReportingValidationError.md +25 -0
  30. package/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +17 -0
  31. package/docs/InvoiceInput.md +1 -1
  32. package/docs/InvoiceTypeCode.md +28 -6
  33. package/docs/{FactureElectroniqueRestApiSchemasConvertValidationError.md → SchematronValidationError.md} +3 -3
  34. package/docs/SimplifiedInvoiceData.md +1 -1
  35. package/docs/ValidateEReportingResponse.md +2 -2
  36. package/docs/ValidationInfo.md +1 -1
  37. package/models/ereporting-validation-error.ts +31 -0
  38. package/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.ts +32 -0
  39. package/models/index.ts +3 -2
  40. package/models/invoice-input.ts +2 -2
  41. package/models/invoice-type-code.ts +65 -6
  42. package/models/{facture-electronique-rest-api-schemas-convert-validation-error.ts → schematron-validation-error.ts} +1 -1
  43. package/models/simplified-invoice-data.ts +2 -2
  44. package/models/validate-ereporting-response.ts +3 -3
  45. package/models/validation-info.ts +2 -2
  46. package/package.json +1 -1
  47. package/dist/esm/models/facture-electronique-models-invoice-type-code.d.ts +0 -81
  48. package/dist/esm/models/facture-electronique-models-invoice-type-code.js +0 -82
  49. package/dist/models/facture-electronique-models-invoice-type-code.d.ts +0 -81
  50. package/dist/models/facture-electronique-models-invoice-type-code.js +0 -85
  51. package/docs/FactureElectroniqueModelsInvoiceTypeCode.md +0 -39
  52. package/models/facture-electronique-models-invoice-type-code.ts +0 -91
  53. /package/dist/esm/models/{facture-electronique-rest-api-schemas-convert-validation-error.js → ereporting-validation-error.js} +0 -0
  54. /package/dist/models/{facture-electronique-rest-api-schemas-convert-validation-error.js → ereporting-validation-error.js} +0 -0
@@ -158,6 +158,7 @@ docs/DocumentTypeInfo.md
158
158
  docs/DownloadsApi.md
159
159
  docs/EReportingApi.md
160
160
  docs/EReportingFlowType.md
161
+ docs/EReportingValidationError.md
161
162
  docs/ElectronicAddress.md
162
163
  docs/EnrichedInvoiceInfo.md
163
164
  docs/ErrorLevel.md
@@ -165,8 +166,7 @@ docs/ErrorSource.md
165
166
  docs/ExtractionInfo.md
166
167
  docs/FacturXInvoice.md
167
168
  docs/FacturXPDFInfo.md
168
- docs/FactureElectroniqueModelsInvoiceTypeCode.md
169
- docs/FactureElectroniqueRestApiSchemasConvertValidationError.md
169
+ docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md
170
170
  docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md
171
171
  docs/FieldStatus.md
172
172
  docs/FileInfo.md
@@ -241,6 +241,7 @@ docs/ReportPeriod.md
241
241
  docs/ReportSender.md
242
242
  docs/RoundingAmount.md
243
243
  docs/RoutingCodeInclude.md
244
+ docs/SchematronValidationError.md
244
245
  docs/SchemeID.md
245
246
  docs/SearchFlowRequest.md
246
247
  docs/SearchFlowResponse.md
@@ -443,13 +444,13 @@ models/document-type-info.ts
443
444
  models/electronic-address.ts
444
445
  models/enriched-invoice-info.ts
445
446
  models/ereporting-flow-type.ts
447
+ models/ereporting-validation-error.ts
446
448
  models/error-level.ts
447
449
  models/error-source.ts
448
450
  models/extraction-info.ts
449
451
  models/factur-xinvoice.ts
450
452
  models/factur-xpdfinfo.ts
451
- models/facture-electronique-models-invoice-type-code.ts
452
- models/facture-electronique-rest-api-schemas-convert-validation-error.ts
453
+ models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.ts
453
454
  models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.ts
454
455
  models/field-status.ts
455
456
  models/file-info.ts
@@ -522,6 +523,7 @@ models/report-period.ts
522
523
  models/report-sender.ts
523
524
  models/rounding-amount.ts
524
525
  models/routing-code-include.ts
526
+ models/schematron-validation-error.ts
525
527
  models/scheme-id.ts
526
528
  models/search-flow-request.ts
527
529
  models/search-flow-response.ts
package/CHANGELOG.md CHANGED
@@ -7,7 +7,7 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
- ## [3.0.18] - 2026-01-14
10
+ ## [3.0.23] - 2026-01-15
11
11
 
12
12
  ### Added
13
13
  - Version initiale du SDK typescript
@@ -24,5 +24,5 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
24
24
  - Guide d'authentification JWT
25
25
  - Configuration avancée (timeout, proxy, debug)
26
26
 
27
- [Unreleased]: https://github.com/factpulse/sdk-typescript/compare/v3.0.18...HEAD
28
- [3.0.18]: https://github.com/factpulse/sdk-typescript/releases/tag/v3.0.18
27
+ [Unreleased]: https://github.com/factpulse/sdk-typescript/compare/v3.0.23...HEAD
28
+ [3.0.23]: https://github.com/factpulse/sdk-typescript/releases/tag/v3.0.23
@@ -0,0 +1,25 @@
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
+ * Validation error detail for E-Reporting.
14
+ */
15
+ export interface EReportingValidationError {
16
+ /**
17
+ * Field path with error
18
+ */
19
+ 'field': string;
20
+ /**
21
+ * Error message
22
+ */
23
+ 'message': string;
24
+ 'code'?: string | null;
25
+ }
@@ -0,0 +1,22 @@
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
+ * Invoice type codes (UNTDID 1001).
14
+ */
15
+ export declare const FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode: {
16
+ readonly _380: "380";
17
+ readonly _381: "381";
18
+ readonly _384: "384";
19
+ readonly _389: "389";
20
+ readonly _386: "386";
21
+ };
22
+ export type FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode = typeof FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode[keyof typeof FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode];
@@ -0,0 +1,23 @@
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://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/
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: contact@factpulse.fr
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
+ * Invoice type codes (UNTDID 1001).
16
+ */
17
+ export const FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode = {
18
+ _380: '380',
19
+ _381: '381',
20
+ _384: '384',
21
+ _389: '389',
22
+ _386: '386'
23
+ };
@@ -132,6 +132,7 @@ export * from './directory-line-include';
132
132
  export * from './doc-type';
133
133
  export * from './document-type-info';
134
134
  export * from './ereporting-flow-type';
135
+ export * from './ereporting-validation-error';
135
136
  export * from './electronic-address';
136
137
  export * from './enriched-invoice-info';
137
138
  export * from './error-level';
@@ -139,8 +140,7 @@ export * from './error-source';
139
140
  export * from './extraction-info';
140
141
  export * from './factur-xinvoice';
141
142
  export * from './factur-xpdfinfo';
142
- export * from './facture-electronique-models-invoice-type-code';
143
- export * from './facture-electronique-rest-api-schemas-convert-validation-error';
143
+ export * from './facture-electronique-rest-api-schemas-ereporting-invoice-type-code';
144
144
  export * from './facture-electronique-rest-api-schemas-processing-chorus-pro-credentials';
145
145
  export * from './field-status';
146
146
  export * from './file-info';
@@ -212,6 +212,7 @@ export * from './report-period';
212
212
  export * from './report-sender';
213
213
  export * from './rounding-amount';
214
214
  export * from './routing-code-include';
215
+ export * from './schematron-validation-error';
215
216
  export * from './scheme-id';
216
217
  export * from './search-flow-request';
217
218
  export * from './search-flow-response';
@@ -132,6 +132,7 @@ export * from './directory-line-include';
132
132
  export * from './doc-type';
133
133
  export * from './document-type-info';
134
134
  export * from './ereporting-flow-type';
135
+ export * from './ereporting-validation-error';
135
136
  export * from './electronic-address';
136
137
  export * from './enriched-invoice-info';
137
138
  export * from './error-level';
@@ -139,8 +140,7 @@ export * from './error-source';
139
140
  export * from './extraction-info';
140
141
  export * from './factur-xinvoice';
141
142
  export * from './factur-xpdfinfo';
142
- export * from './facture-electronique-models-invoice-type-code';
143
- export * from './facture-electronique-rest-api-schemas-convert-validation-error';
143
+ export * from './facture-electronique-rest-api-schemas-ereporting-invoice-type-code';
144
144
  export * from './facture-electronique-rest-api-schemas-processing-chorus-pro-credentials';
145
145
  export * from './field-status';
146
146
  export * from './file-info';
@@ -212,6 +212,7 @@ export * from './report-period';
212
212
  export * from './report-sender';
213
213
  export * from './rounding-amount';
214
214
  export * from './routing-code-include';
215
+ export * from './schematron-validation-error';
215
216
  export * from './scheme-id';
216
217
  export * from './search-flow-request';
217
218
  export * from './search-flow-response';
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { Buyercountry } from './buyercountry';
13
13
  import type { Currency } from './currency';
14
- import type { InvoiceTypeCode } from './invoice-type-code';
14
+ import type { FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode } from './facture-electronique-rest-api-schemas-ereporting-invoice-type-code';
15
15
  import type { Sellercountry } from './sellercountry';
16
16
  import type { TaxBreakdownInput } from './tax-breakdown-input';
17
17
  import type { Taxamount1 } from './taxamount1';
@@ -31,7 +31,7 @@ export interface InvoiceInput {
31
31
  /**
32
32
  * Invoice type code
33
33
  */
34
- 'typeCode'?: InvoiceTypeCode;
34
+ 'typeCode'?: FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode;
35
35
  'currency'?: Currency;
36
36
  'dueDate'?: string | null;
37
37
  /**
@@ -10,13 +10,72 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Invoice type codes (UNTDID 1001).
13
+ * Document type according to BR-FR-04 (UNTDID 1001 codes). | Code | Name | Description | |------|------|-------------| | 380 | INVOICE | Commercial invoice | | 389 | SELF_BILLED_INVOICE | Self-billed invoice | | 393 | FACTORED_INVOICE | Factored invoice | | 501 | SELF_BILLED_FACTORED_INVOICE | Self-billed factored invoice | | 386 | PREPAYMENT_INVOICE | Prepayment invoice | | 500 | SELF_BILLED_PREPAYMENT_INVOICE | Self-billed prepayment invoice | | 384 | CORRECTIVE_INVOICE | Corrective invoice | | 471 | SELF_BILLED_CORRECTIVE_INVOICE | Self-billed corrective invoice | | 472 | FACTORED_CORRECTIVE_INVOICE | Factored corrective invoice | | 473 | SELF_BILLED_FACTORED_CORRECTIVE_INVOICE | Self-billed factored corrective invoice | | 381 | CREDIT_NOTE | Credit note | | 261 | SELF_BILLED_CREDIT_NOTE | Self-billed credit note | | 262 | GLOBAL_ALLOWANCE_CREDIT_NOTE | Credit note for global allowance | | 396 | FACTORED_CREDIT_NOTE | Factored credit note | | 502 | SELF_BILLED_FACTORED_CREDIT_NOTE | Self-billed factored credit note | | 503 | PREPAYMENT_CREDIT_NOTE | Credit note for prepayment invoice |
14
14
  */
15
15
  export declare const InvoiceTypeCode: {
16
- readonly _380: "380";
17
- readonly _381: "381";
18
- readonly _384: "384";
19
- readonly _389: "389";
20
- readonly _386: "386";
16
+ /**
17
+ * Commercial Invoice
18
+ */
19
+ readonly INVOICE: "380";
20
+ /**
21
+ * Self-billed Invoice
22
+ */
23
+ readonly SELF_BILLED_INVOICE: "389";
24
+ /**
25
+ * Factored Invoice
26
+ */
27
+ readonly FACTORED_INVOICE: "393";
28
+ /**
29
+ * Self-billed Factored Invoice
30
+ */
31
+ readonly SELF_BILLED_FACTORED_INVOICE: "501";
32
+ /**
33
+ * Prepayment Invoice
34
+ */
35
+ readonly PREPAYMENT_INVOICE: "386";
36
+ /**
37
+ * Self-billed Prepayment Invoice
38
+ */
39
+ readonly SELF_BILLED_PREPAYMENT_INVOICE: "500";
40
+ /**
41
+ * Corrective Invoice
42
+ */
43
+ readonly CORRECTIVE_INVOICE: "384";
44
+ /**
45
+ * Self-billed Corrective Invoice
46
+ */
47
+ readonly SELF_BILLED_CORRECTIVE_INVOICE: "471";
48
+ /**
49
+ * Factored Corrective Invoice
50
+ */
51
+ readonly FACTORED_CORRECTIVE_INVOICE: "472";
52
+ /**
53
+ * Self-billed Factored Corrective Invoice
54
+ */
55
+ readonly SELF_BILLED_FACTORED_CORRECTIVE_INVOICE: "473";
56
+ /**
57
+ * Credit Note
58
+ */
59
+ readonly CREDIT_NOTE: "381";
60
+ /**
61
+ * Self-billed Credit Note
62
+ */
63
+ readonly SELF_BILLED_CREDIT_NOTE: "261";
64
+ /**
65
+ * Global Allowance Credit Note
66
+ */
67
+ readonly GLOBAL_ALLOWANCE_CREDIT_NOTE: "262";
68
+ /**
69
+ * Factored Credit Note
70
+ */
71
+ readonly FACTORED_CREDIT_NOTE: "396";
72
+ /**
73
+ * Self-billed Factored Credit Note
74
+ */
75
+ readonly SELF_BILLED_FACTORED_CREDIT_NOTE: "502";
76
+ /**
77
+ * Prepayment Credit Note
78
+ */
79
+ readonly PREPAYMENT_CREDIT_NOTE: "503";
21
80
  };
22
81
  export type InvoiceTypeCode = typeof InvoiceTypeCode[keyof typeof InvoiceTypeCode];
@@ -12,12 +12,71 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * Invoice type codes (UNTDID 1001).
15
+ * Document type according to BR-FR-04 (UNTDID 1001 codes). | Code | Name | Description | |------|------|-------------| | 380 | INVOICE | Commercial invoice | | 389 | SELF_BILLED_INVOICE | Self-billed invoice | | 393 | FACTORED_INVOICE | Factored invoice | | 501 | SELF_BILLED_FACTORED_INVOICE | Self-billed factored invoice | | 386 | PREPAYMENT_INVOICE | Prepayment invoice | | 500 | SELF_BILLED_PREPAYMENT_INVOICE | Self-billed prepayment invoice | | 384 | CORRECTIVE_INVOICE | Corrective invoice | | 471 | SELF_BILLED_CORRECTIVE_INVOICE | Self-billed corrective invoice | | 472 | FACTORED_CORRECTIVE_INVOICE | Factored corrective invoice | | 473 | SELF_BILLED_FACTORED_CORRECTIVE_INVOICE | Self-billed factored corrective invoice | | 381 | CREDIT_NOTE | Credit note | | 261 | SELF_BILLED_CREDIT_NOTE | Self-billed credit note | | 262 | GLOBAL_ALLOWANCE_CREDIT_NOTE | Credit note for global allowance | | 396 | FACTORED_CREDIT_NOTE | Factored credit note | | 502 | SELF_BILLED_FACTORED_CREDIT_NOTE | Self-billed factored credit note | | 503 | PREPAYMENT_CREDIT_NOTE | Credit note for prepayment invoice |
16
16
  */
17
17
  export const InvoiceTypeCode = {
18
- _380: '380',
19
- _381: '381',
20
- _384: '384',
21
- _389: '389',
22
- _386: '386'
18
+ /**
19
+ * Commercial Invoice
20
+ */
21
+ INVOICE: '380',
22
+ /**
23
+ * Self-billed Invoice
24
+ */
25
+ SELF_BILLED_INVOICE: '389',
26
+ /**
27
+ * Factored Invoice
28
+ */
29
+ FACTORED_INVOICE: '393',
30
+ /**
31
+ * Self-billed Factored Invoice
32
+ */
33
+ SELF_BILLED_FACTORED_INVOICE: '501',
34
+ /**
35
+ * Prepayment Invoice
36
+ */
37
+ PREPAYMENT_INVOICE: '386',
38
+ /**
39
+ * Self-billed Prepayment Invoice
40
+ */
41
+ SELF_BILLED_PREPAYMENT_INVOICE: '500',
42
+ /**
43
+ * Corrective Invoice
44
+ */
45
+ CORRECTIVE_INVOICE: '384',
46
+ /**
47
+ * Self-billed Corrective Invoice
48
+ */
49
+ SELF_BILLED_CORRECTIVE_INVOICE: '471',
50
+ /**
51
+ * Factored Corrective Invoice
52
+ */
53
+ FACTORED_CORRECTIVE_INVOICE: '472',
54
+ /**
55
+ * Self-billed Factored Corrective Invoice
56
+ */
57
+ SELF_BILLED_FACTORED_CORRECTIVE_INVOICE: '473',
58
+ /**
59
+ * Credit Note
60
+ */
61
+ CREDIT_NOTE: '381',
62
+ /**
63
+ * Self-billed Credit Note
64
+ */
65
+ SELF_BILLED_CREDIT_NOTE: '261',
66
+ /**
67
+ * Global Allowance Credit Note
68
+ */
69
+ GLOBAL_ALLOWANCE_CREDIT_NOTE: '262',
70
+ /**
71
+ * Factored Credit Note
72
+ */
73
+ FACTORED_CREDIT_NOTE: '396',
74
+ /**
75
+ * Self-billed Factored Credit Note
76
+ */
77
+ SELF_BILLED_FACTORED_CREDIT_NOTE: '502',
78
+ /**
79
+ * Prepayment Credit Note
80
+ */
81
+ PREPAYMENT_CREDIT_NOTE: '503'
23
82
  };
@@ -12,7 +12,7 @@
12
12
  /**
13
13
  * Erreur de validation Schematron avec suggestion de correction.
14
14
  */
15
- export interface FactureElectroniqueRestApiSchemasConvertValidationError {
15
+ export interface SchematronValidationError {
16
16
  /**
17
17
  * Code de la regle (BR-XX, BR-FR-XX)
18
18
  */
@@ -0,0 +1,14 @@
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://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/
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: contact@factpulse.fr
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
+ export {};
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { FactureElectroniqueModelsInvoiceTypeCode } from './facture-electronique-models-invoice-type-code';
12
+ import type { InvoiceTypeCode } from './invoice-type-code';
13
13
  import type { InvoicingFrameworkCode } from './invoicing-framework-code';
14
14
  import type { OperationNature } from './operation-nature';
15
15
  /**
@@ -49,7 +49,7 @@ export interface SimplifiedInvoiceData {
49
49
  /**
50
50
  * Document type (UNTDID 1001). Default: 380 (Invoice).
51
51
  */
52
- 'invoiceType'?: FactureElectroniqueModelsInvoiceTypeCode;
52
+ 'invoiceType'?: InvoiceTypeCode;
53
53
  'precedingInvoiceReference'?: string | null;
54
54
  'operationNature'?: OperationNature | null;
55
55
  'invoicingFramework'?: InvoicingFrameworkCode | null;
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { ValidationError } from './validation-error';
12
+ import type { EReportingValidationError } from './ereporting-validation-error';
13
13
  /**
14
14
  * Response after validating e-reporting data.
15
15
  */
@@ -29,11 +29,11 @@ export interface ValidateEReportingResponse {
29
29
  /**
30
30
  * List of validation errors (if any)
31
31
  */
32
- 'errors'?: Array<ValidationError>;
32
+ 'errors'?: Array<EReportingValidationError>;
33
33
  /**
34
34
  * List of validation warnings (if any)
35
35
  */
36
- 'warnings'?: Array<ValidationError>;
36
+ 'warnings'?: Array<EReportingValidationError>;
37
37
  /**
38
38
  * Status message
39
39
  */
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { FactureElectroniqueRestApiSchemasConvertValidationError } from './facture-electronique-rest-api-schemas-convert-validation-error';
12
+ import type { SchematronValidationError } from './schematron-validation-error';
13
13
  /**
14
14
  * Informations sur la validation.
15
15
  */
@@ -34,5 +34,5 @@ export interface ValidationInfo {
34
34
  * XML embarque dans PDF
35
35
  */
36
36
  'xml_embedded'?: boolean;
37
- 'errors'?: Array<FactureElectroniqueRestApiSchemasConvertValidationError>;
37
+ 'errors'?: Array<SchematronValidationError>;
38
38
  }
@@ -0,0 +1,25 @@
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
+ * Validation error detail for E-Reporting.
14
+ */
15
+ export interface EReportingValidationError {
16
+ /**
17
+ * Field path with error
18
+ */
19
+ 'field': string;
20
+ /**
21
+ * Error message
22
+ */
23
+ 'message': string;
24
+ 'code'?: string | null;
25
+ }
@@ -0,0 +1,22 @@
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
+ * Invoice type codes (UNTDID 1001).
14
+ */
15
+ export declare const FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode: {
16
+ readonly _380: "380";
17
+ readonly _381: "381";
18
+ readonly _384: "384";
19
+ readonly _389: "389";
20
+ readonly _386: "386";
21
+ };
22
+ export type FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode = typeof FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode[keyof typeof FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode];
@@ -0,0 +1,26 @@
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
+ exports.FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode = void 0;
17
+ /**
18
+ * Invoice type codes (UNTDID 1001).
19
+ */
20
+ exports.FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode = {
21
+ _380: '380',
22
+ _381: '381',
23
+ _384: '384',
24
+ _389: '389',
25
+ _386: '386'
26
+ };
@@ -132,6 +132,7 @@ export * from './directory-line-include';
132
132
  export * from './doc-type';
133
133
  export * from './document-type-info';
134
134
  export * from './ereporting-flow-type';
135
+ export * from './ereporting-validation-error';
135
136
  export * from './electronic-address';
136
137
  export * from './enriched-invoice-info';
137
138
  export * from './error-level';
@@ -139,8 +140,7 @@ export * from './error-source';
139
140
  export * from './extraction-info';
140
141
  export * from './factur-xinvoice';
141
142
  export * from './factur-xpdfinfo';
142
- export * from './facture-electronique-models-invoice-type-code';
143
- export * from './facture-electronique-rest-api-schemas-convert-validation-error';
143
+ export * from './facture-electronique-rest-api-schemas-ereporting-invoice-type-code';
144
144
  export * from './facture-electronique-rest-api-schemas-processing-chorus-pro-credentials';
145
145
  export * from './field-status';
146
146
  export * from './file-info';
@@ -212,6 +212,7 @@ export * from './report-period';
212
212
  export * from './report-sender';
213
213
  export * from './rounding-amount';
214
214
  export * from './routing-code-include';
215
+ export * from './schematron-validation-error';
215
216
  export * from './scheme-id';
216
217
  export * from './search-flow-request';
217
218
  export * from './search-flow-response';