@factpulse/sdk 3.0.31 → 3.0.33

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 (212) hide show
  1. package/.openapi-generator/FILES +44 -4
  2. package/CHANGELOG.md +9 -17
  3. package/api/afnorpdppaapi.ts +1 -1
  4. package/api/afnorpdppadirectory-service-api.ts +1 -1
  5. package/api/afnorpdppaflow-service-api.ts +1 -1
  6. package/api/cdarcycle-de-vie-api.ts +603 -0
  7. package/api/chorus-pro-api.ts +1 -1
  8. package/api/document-conversion-api.ts +1 -1
  9. package/api/downloads-api.ts +1 -1
  10. package/api/ereporting-api.ts +1 -1
  11. package/api/health-api.ts +1 -1
  12. package/api/invoice-processing-api.ts +3 -3
  13. package/api/pdfxmlverification-api.ts +1 -1
  14. package/api/user-api.ts +1 -1
  15. package/api.ts +1 -0
  16. package/dist/api/cdarcycle-de-vie-api.d.ts +280 -0
  17. package/dist/api/cdarcycle-de-vie-api.js +569 -0
  18. package/dist/api.d.ts +1 -0
  19. package/dist/api.js +1 -0
  20. package/dist/esm/api/cdarcycle-de-vie-api.d.ts +280 -0
  21. package/dist/esm/api/cdarcycle-de-vie-api.js +559 -0
  22. package/dist/esm/api.d.ts +1 -0
  23. package/dist/esm/api.js +1 -0
  24. package/dist/{models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts → esm/models/action-code-info.d.ts} +12 -8
  25. package/dist/esm/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts → action-codes-response.d.ts} +13 -8
  26. package/dist/esm/models/action-codes-response.js +14 -0
  27. package/dist/esm/models/body-submit-cdar-api-v1-cdar-submit-post.d.ts +17 -0
  28. package/dist/esm/models/body-submit-cdar-api-v1-cdar-submit-post.js +14 -0
  29. package/dist/esm/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts +17 -0
  30. package/dist/esm/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js +14 -0
  31. package/dist/esm/models/chorus-pro-credentials.d.ts +7 -19
  32. package/dist/esm/models/chorus-pro-destination.d.ts +2 -2
  33. package/dist/esm/models/create-cdarrequest.d.ts +66 -0
  34. package/dist/esm/models/create-cdarrequest.js +14 -0
  35. package/dist/esm/models/encaisseamount.d.ts +16 -0
  36. package/dist/esm/models/encaisseamount.js +14 -0
  37. package/dist/esm/models/encaisseamount1.d.ts +13 -0
  38. package/dist/esm/models/encaisseamount1.js +14 -0
  39. package/dist/esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +36 -0
  40. package/dist/esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js +14 -0
  41. package/dist/esm/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.d.ts +22 -0
  42. package/dist/esm/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.js +23 -0
  43. package/dist/esm/models/facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts +20 -0
  44. package/dist/esm/models/facture-electronique-rest-api-schemas-validation-validation-error-response.js +14 -0
  45. package/dist/esm/models/generate-cdarresponse.d.ts +33 -0
  46. package/dist/esm/models/generate-cdarresponse.js +14 -0
  47. package/dist/esm/models/get-chorus-pro-id-request.d.ts +2 -2
  48. package/dist/esm/models/get-invoice-request.d.ts +2 -2
  49. package/dist/esm/models/get-structure-request.d.ts +2 -2
  50. package/dist/esm/models/index.d.ts +21 -2
  51. package/dist/esm/models/index.js +21 -2
  52. package/dist/esm/models/invoice-input.d.ts +2 -2
  53. package/dist/esm/models/invoice-type-code.d.ts +65 -6
  54. package/dist/esm/models/invoice-type-code.js +65 -6
  55. package/dist/esm/models/reason-code-info.d.ts +28 -0
  56. package/dist/esm/models/reason-code-info.js +14 -0
  57. package/dist/esm/models/reason-codes-response.d.ts +29 -0
  58. package/dist/esm/models/reason-codes-response.js +14 -0
  59. package/dist/esm/models/recipient-input.d.ts +24 -0
  60. package/dist/esm/models/recipient-input.js +14 -0
  61. package/dist/esm/models/search-structure-request.d.ts +2 -2
  62. package/dist/esm/models/simplified-invoice-data.d.ts +2 -2
  63. package/dist/esm/models/status-code-info.d.ts +28 -0
  64. package/dist/esm/models/status-code-info.js +14 -0
  65. package/dist/esm/models/status-codes-response.d.ts +29 -0
  66. package/dist/esm/models/status-codes-response.js +14 -0
  67. package/dist/esm/models/submit-cdarrequest.d.ts +70 -0
  68. package/dist/esm/models/submit-cdarrequest.js +14 -0
  69. package/dist/esm/models/submit-cdarresponse.d.ts +26 -0
  70. package/dist/esm/models/submit-cdarresponse.js +14 -0
  71. package/dist/esm/models/submit-cdarxmlrequest.d.ts +25 -0
  72. package/dist/esm/models/submit-cdarxmlrequest.js +14 -0
  73. package/dist/esm/models/submit-invoice-request.d.ts +2 -2
  74. package/dist/esm/models/validate-cdarrequest.d.ts +25 -0
  75. package/dist/esm/models/validate-cdarrequest.js +14 -0
  76. package/dist/esm/models/validate-cdarresponse.d.ts +29 -0
  77. package/dist/esm/models/validate-cdarresponse.js +14 -0
  78. package/dist/esm/models/validation-error-response.d.ts +12 -3
  79. package/dist/esm/src/helpers/client.js +3 -0
  80. package/dist/models/action-code-info.d.ts +28 -0
  81. package/dist/models/action-codes-response.d.ts +29 -0
  82. package/dist/models/action-codes-response.js +15 -0
  83. package/dist/models/body-submit-cdar-api-v1-cdar-submit-post.d.ts +17 -0
  84. package/dist/models/body-submit-cdar-api-v1-cdar-submit-post.js +15 -0
  85. package/dist/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts +17 -0
  86. package/dist/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js +15 -0
  87. package/dist/models/chorus-pro-credentials.d.ts +7 -19
  88. package/dist/models/chorus-pro-destination.d.ts +2 -2
  89. package/dist/models/create-cdarrequest.d.ts +66 -0
  90. package/dist/models/create-cdarrequest.js +15 -0
  91. package/dist/models/encaisseamount.d.ts +16 -0
  92. package/dist/models/encaisseamount.js +15 -0
  93. package/dist/models/encaisseamount1.d.ts +13 -0
  94. package/dist/models/encaisseamount1.js +15 -0
  95. package/dist/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +36 -0
  96. package/dist/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js +15 -0
  97. package/dist/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.d.ts +22 -0
  98. package/dist/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.js +26 -0
  99. package/dist/models/facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts +20 -0
  100. package/dist/models/facture-electronique-rest-api-schemas-validation-validation-error-response.js +15 -0
  101. package/dist/models/generate-cdarresponse.d.ts +33 -0
  102. package/dist/models/generate-cdarresponse.js +15 -0
  103. package/dist/models/get-chorus-pro-id-request.d.ts +2 -2
  104. package/dist/models/get-invoice-request.d.ts +2 -2
  105. package/dist/models/get-structure-request.d.ts +2 -2
  106. package/dist/models/index.d.ts +21 -2
  107. package/dist/models/index.js +21 -2
  108. package/dist/models/invoice-input.d.ts +2 -2
  109. package/dist/models/invoice-type-code.d.ts +65 -6
  110. package/dist/models/invoice-type-code.js +65 -6
  111. package/dist/models/reason-code-info.d.ts +28 -0
  112. package/dist/models/reason-code-info.js +15 -0
  113. package/dist/models/reason-codes-response.d.ts +29 -0
  114. package/dist/models/reason-codes-response.js +15 -0
  115. package/dist/models/recipient-input.d.ts +24 -0
  116. package/dist/models/recipient-input.js +15 -0
  117. package/dist/models/search-structure-request.d.ts +2 -2
  118. package/dist/models/simplified-invoice-data.d.ts +2 -2
  119. package/dist/models/status-code-info.d.ts +28 -0
  120. package/dist/models/status-code-info.js +15 -0
  121. package/dist/models/status-codes-response.d.ts +29 -0
  122. package/dist/models/status-codes-response.js +15 -0
  123. package/dist/models/submit-cdarrequest.d.ts +70 -0
  124. package/dist/models/submit-cdarrequest.js +15 -0
  125. package/dist/models/submit-cdarresponse.d.ts +26 -0
  126. package/dist/models/submit-cdarresponse.js +15 -0
  127. package/dist/models/submit-cdarxmlrequest.d.ts +25 -0
  128. package/dist/models/submit-cdarxmlrequest.js +15 -0
  129. package/dist/models/submit-invoice-request.d.ts +2 -2
  130. package/dist/models/validate-cdarrequest.d.ts +25 -0
  131. package/dist/models/validate-cdarrequest.js +15 -0
  132. package/dist/models/validate-cdarresponse.d.ts +29 -0
  133. package/dist/models/validate-cdarresponse.js +15 -0
  134. package/dist/models/validation-error-response.d.ts +12 -3
  135. package/dist/src/helpers/client.js +3 -0
  136. package/docs/ActionCodeInfo.md +25 -0
  137. package/docs/ActionCodesResponse.md +25 -0
  138. package/docs/BodySubmitCdarApiV1CdarSubmitPost.md +22 -0
  139. package/docs/BodySubmitCdarXmlApiV1CdarSubmitXmlPost.md +22 -0
  140. package/docs/CDARCycleDeVieApi.md +397 -0
  141. package/docs/ChorusProCredentials.md +9 -9
  142. package/docs/ChorusProDestination.md +1 -1
  143. package/docs/CreateCDARRequest.md +55 -0
  144. package/docs/Encaisseamount.md +19 -0
  145. package/docs/Encaisseamount1.md +18 -0
  146. package/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +29 -0
  147. package/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +17 -0
  148. package/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +21 -0
  149. package/docs/GenerateCDARResponse.md +29 -0
  150. package/docs/GetChorusProIdRequest.md +1 -1
  151. package/docs/GetInvoiceRequest.md +1 -1
  152. package/docs/GetStructureRequest.md +1 -1
  153. package/docs/InvoiceInput.md +1 -1
  154. package/docs/InvoiceTypeCode.md +28 -6
  155. package/docs/ReasonCodeInfo.md +25 -0
  156. package/docs/ReasonCodesResponse.md +25 -0
  157. package/docs/RecipientInput.md +29 -0
  158. package/docs/SearchStructureRequest.md +1 -1
  159. package/docs/SimplifiedInvoiceData.md +1 -1
  160. package/docs/StatusCodeInfo.md +25 -0
  161. package/docs/StatusCodesResponse.md +25 -0
  162. package/docs/SubmitCDARRequest.md +57 -0
  163. package/docs/SubmitCDARResponse.md +27 -0
  164. package/docs/SubmitCDARXMLRequest.md +25 -0
  165. package/docs/SubmitInvoiceRequest.md +1 -1
  166. package/docs/ValidateCDARRequest.md +35 -0
  167. package/docs/ValidateCDARResponse.md +25 -0
  168. package/docs/ValidationErrorResponse.md +9 -3
  169. package/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.ts → action-code-info.ts} +12 -8
  170. package/models/action-codes-response.ts +37 -0
  171. package/models/body-submit-cdar-api-v1-cdar-submit-post.ts +27 -0
  172. package/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.ts +27 -0
  173. package/models/chorus-pro-credentials.ts +7 -19
  174. package/models/chorus-pro-destination.ts +2 -2
  175. package/models/create-cdarrequest.ts +76 -0
  176. package/models/encaisseamount.ts +22 -0
  177. package/models/encaisseamount1.ts +19 -0
  178. package/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.ts +42 -0
  179. package/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.ts +32 -0
  180. package/models/facture-electronique-rest-api-schemas-validation-validation-error-response.ts +26 -0
  181. package/models/generate-cdarresponse.ts +39 -0
  182. package/models/get-chorus-pro-id-request.ts +2 -2
  183. package/models/get-invoice-request.ts +2 -2
  184. package/models/get-structure-request.ts +2 -2
  185. package/models/index.ts +21 -2
  186. package/models/invoice-input.ts +2 -2
  187. package/models/invoice-type-code.ts +65 -6
  188. package/models/reason-code-info.ts +34 -0
  189. package/models/reason-codes-response.ts +37 -0
  190. package/models/recipient-input.ts +30 -0
  191. package/models/search-structure-request.ts +2 -2
  192. package/models/simplified-invoice-data.ts +2 -2
  193. package/models/status-code-info.ts +34 -0
  194. package/models/status-codes-response.ts +37 -0
  195. package/models/submit-cdarrequest.ts +80 -0
  196. package/models/submit-cdarresponse.ts +32 -0
  197. package/models/submit-cdarxmlrequest.ts +31 -0
  198. package/models/submit-invoice-request.ts +2 -2
  199. package/models/validate-cdarrequest.ts +33 -0
  200. package/models/validate-cdarresponse.ts +37 -0
  201. package/models/validation-error-response.ts +12 -3
  202. package/package.json +1 -1
  203. package/src/helpers/client.ts +3 -0
  204. package/dist/esm/models/facture-electronique-models-invoice-type-code.d.ts +0 -81
  205. package/dist/esm/models/facture-electronique-models-invoice-type-code.js +0 -82
  206. package/dist/models/facture-electronique-models-invoice-type-code.d.ts +0 -81
  207. package/dist/models/facture-electronique-models-invoice-type-code.js +0 -85
  208. package/docs/FactureElectroniqueModelsInvoiceTypeCode.md +0 -39
  209. package/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +0 -29
  210. package/models/facture-electronique-models-invoice-type-code.ts +0 -91
  211. /package/dist/esm/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js → action-code-info.js} +0 -0
  212. /package/dist/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js → action-code-info.js} +0 -0
@@ -15,15 +15,74 @@
15
15
 
16
16
 
17
17
  /**
18
- * Invoice type codes (UNTDID 1001).
18
+ * 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 |
19
19
  */
20
20
 
21
21
  export const InvoiceTypeCode = {
22
- _380: '380',
23
- _381: '381',
24
- _384: '384',
25
- _389: '389',
26
- _386: '386'
22
+ /**
23
+ * Commercial Invoice
24
+ */
25
+ INVOICE: '380',
26
+ /**
27
+ * Self-billed Invoice
28
+ */
29
+ SELF_BILLED_INVOICE: '389',
30
+ /**
31
+ * Factored Invoice
32
+ */
33
+ FACTORED_INVOICE: '393',
34
+ /**
35
+ * Self-billed Factored Invoice
36
+ */
37
+ SELF_BILLED_FACTORED_INVOICE: '501',
38
+ /**
39
+ * Prepayment Invoice
40
+ */
41
+ PREPAYMENT_INVOICE: '386',
42
+ /**
43
+ * Self-billed Prepayment Invoice
44
+ */
45
+ SELF_BILLED_PREPAYMENT_INVOICE: '500',
46
+ /**
47
+ * Corrective Invoice
48
+ */
49
+ CORRECTIVE_INVOICE: '384',
50
+ /**
51
+ * Self-billed Corrective Invoice
52
+ */
53
+ SELF_BILLED_CORRECTIVE_INVOICE: '471',
54
+ /**
55
+ * Factored Corrective Invoice
56
+ */
57
+ FACTORED_CORRECTIVE_INVOICE: '472',
58
+ /**
59
+ * Self-billed Factored Corrective Invoice
60
+ */
61
+ SELF_BILLED_FACTORED_CORRECTIVE_INVOICE: '473',
62
+ /**
63
+ * Credit Note
64
+ */
65
+ CREDIT_NOTE: '381',
66
+ /**
67
+ * Self-billed Credit Note
68
+ */
69
+ SELF_BILLED_CREDIT_NOTE: '261',
70
+ /**
71
+ * Global Allowance Credit Note
72
+ */
73
+ GLOBAL_ALLOWANCE_CREDIT_NOTE: '262',
74
+ /**
75
+ * Factored Credit Note
76
+ */
77
+ FACTORED_CREDIT_NOTE: '396',
78
+ /**
79
+ * Self-billed Factored Credit Note
80
+ */
81
+ SELF_BILLED_FACTORED_CREDIT_NOTE: '502',
82
+ /**
83
+ * Prepayment Credit Note
84
+ */
85
+ PREPAYMENT_CREDIT_NOTE: '503'
27
86
  } as const;
28
87
 
29
88
  export type InvoiceTypeCode = typeof InvoiceTypeCode[keyof typeof InvoiceTypeCode];
@@ -0,0 +1,34 @@
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
+
16
+
17
+ /**
18
+ * Information sur un code motif.
19
+ */
20
+ export interface ReasonCodeInfo {
21
+ /**
22
+ * Code
23
+ */
24
+ 'code': string;
25
+ /**
26
+ * Nom Python de l\'enum
27
+ */
28
+ 'name': string;
29
+ /**
30
+ * Description
31
+ */
32
+ 'description': string;
33
+ }
34
+
@@ -0,0 +1,37 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * FactPulse REST API
5
+ * REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://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
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { ReasonCodeInfo } from './reason-code-info';
19
+
20
+ /**
21
+ * Liste des codes motif disponibles.
22
+ */
23
+ export interface ReasonCodesResponse {
24
+ /**
25
+ * Liste des codes motif
26
+ */
27
+ 'codes': Array<ReasonCodeInfo>;
28
+ /**
29
+ * Nombre de codes
30
+ */
31
+ 'count': number;
32
+ /**
33
+ * Règle source
34
+ */
35
+ 'source'?: string;
36
+ }
37
+
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * FactPulse REST API
5
+ * REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://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
+
16
+
17
+ /**
18
+ * Destinataire du message CDAR.
19
+ */
20
+ export interface RecipientInput {
21
+ 'siren'?: string | null;
22
+ 'siret'?: string | null;
23
+ 'name'?: string | null;
24
+ /**
25
+ * Code rôle (BY, SE, WK, etc.)
26
+ */
27
+ 'role'?: string;
28
+ 'email'?: string | null;
29
+ }
30
+
@@ -15,13 +15,13 @@
15
15
 
16
16
  // May contain unused imports in some cases
17
17
  // @ts-ignore
18
- import type { ChorusProCredentials } from './chorus-pro-credentials';
18
+ import type { FactureElectroniqueRestApiSchemasChorusProChorusProCredentials } from './facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials';
19
19
 
20
20
  /**
21
21
  * Search structures by criteria.
22
22
  */
23
23
  export interface SearchStructureRequest {
24
- 'credentials'?: ChorusProCredentials | null;
24
+ 'credentials'?: FactureElectroniqueRestApiSchemasChorusProChorusProCredentials | null;
25
25
  'structureIdentifier'?: string | null;
26
26
  'structureIdentifierType'?: string | null;
27
27
  'companyName'?: string | null;
@@ -15,7 +15,7 @@
15
15
 
16
16
  // May contain unused imports in some cases
17
17
  // @ts-ignore
18
- import type { FactureElectroniqueModelsInvoiceTypeCode } from './facture-electronique-models-invoice-type-code';
18
+ import type { InvoiceTypeCode } from './invoice-type-code';
19
19
  // May contain unused imports in some cases
20
20
  // @ts-ignore
21
21
  import type { InvoicingFrameworkCode } from './invoicing-framework-code';
@@ -54,7 +54,7 @@ export interface SimplifiedInvoiceData {
54
54
  /**
55
55
  * Document type (UNTDID 1001). Default: 380 (Invoice).
56
56
  */
57
- 'invoiceType'?: FactureElectroniqueModelsInvoiceTypeCode;
57
+ 'invoiceType'?: InvoiceTypeCode;
58
58
  'precedingInvoiceReference'?: string | null;
59
59
  'operationNature'?: OperationNature | null;
60
60
  'invoicingFramework'?: InvoicingFrameworkCode | null;
@@ -0,0 +1,34 @@
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
+
16
+
17
+ /**
18
+ * Information sur un code statut.
19
+ */
20
+ export interface StatusCodeInfo {
21
+ /**
22
+ * Code numérique
23
+ */
24
+ 'code': string;
25
+ /**
26
+ * Nom Python de l\'enum
27
+ */
28
+ 'name': string;
29
+ /**
30
+ * Description
31
+ */
32
+ 'description': string;
33
+ }
34
+
@@ -0,0 +1,37 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * FactPulse REST API
5
+ * REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://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
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { StatusCodeInfo } from './status-code-info';
19
+
20
+ /**
21
+ * Liste des codes statut disponibles.
22
+ */
23
+ export interface StatusCodesResponse {
24
+ /**
25
+ * Liste des codes statut
26
+ */
27
+ 'codes': Array<StatusCodeInfo>;
28
+ /**
29
+ * Nombre de codes
30
+ */
31
+ 'count': number;
32
+ /**
33
+ * Règle source
34
+ */
35
+ 'source'?: string;
36
+ }
37
+
@@ -0,0 +1,80 @@
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
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { Encaisseamount } from './encaisseamount';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { RecipientInput } from './recipient-input';
22
+
23
+ /**
24
+ * Requête de soumission CDAR (génération + envoi).
25
+ */
26
+ export interface SubmitCDARRequest {
27
+ /**
28
+ * Identifiant unique du message CDAR
29
+ */
30
+ 'documentId': string;
31
+ /**
32
+ * Code processus métier (REGULATED, B2C, B2BINT, etc.)
33
+ */
34
+ 'businessProcess'?: string;
35
+ /**
36
+ * Type de message (23=Traitement, 305=Transmission)
37
+ */
38
+ 'typeCode'?: string;
39
+ /**
40
+ * SIREN de l\'émetteur (9 chiffres)
41
+ */
42
+ 'senderSiren': string;
43
+ /**
44
+ * Rôle de l\'émetteur (WK, SE, BY, etc.)
45
+ */
46
+ 'senderRole'?: string;
47
+ 'senderName'?: string | null;
48
+ 'senderEmail'?: string | null;
49
+ /**
50
+ * Liste des destinataires
51
+ */
52
+ 'recipients'?: Array<RecipientInput>;
53
+ /**
54
+ * Identifiant de la facture (BT-1)
55
+ */
56
+ 'invoiceId': string;
57
+ /**
58
+ * Date d\'émission de la facture (YYYY-MM-DD)
59
+ */
60
+ 'invoiceIssueDate': string;
61
+ /**
62
+ * Type de document (380=Facture, 381=Avoir)
63
+ */
64
+ 'invoiceTypeCode'?: string;
65
+ 'invoiceSellerSiren'?: string | null;
66
+ 'invoiceBuyerSiren'?: string | null;
67
+ /**
68
+ * Code statut de la facture (200-601)
69
+ */
70
+ 'status': string;
71
+ 'reasonCode'?: string | null;
72
+ 'reasonText'?: string | null;
73
+ 'actionCode'?: string | null;
74
+ 'encaisseAmount'?: Encaisseamount | null;
75
+ /**
76
+ * Type de flux AFNOR (CustomerInvoiceLC, SupplierInvoiceLC, etc.)
77
+ */
78
+ 'flowType'?: string;
79
+ }
80
+
@@ -0,0 +1,32 @@
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
+
16
+
17
+ /**
18
+ * Réponse de soumission CDAR.
19
+ */
20
+ export interface SubmitCDARResponse {
21
+ /**
22
+ * Identifiant du flux AFNOR
23
+ */
24
+ 'flowId': string;
25
+ /**
26
+ * Statut de la soumission
27
+ */
28
+ 'status': string;
29
+ 'message'?: string | null;
30
+ 'documentId'?: string | null;
31
+ }
32
+
@@ -0,0 +1,31 @@
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
+
16
+
17
+ /**
18
+ * Requête de soumission d\'un XML CDAR pré-généré.
19
+ */
20
+ export interface SubmitCDARXMLRequest {
21
+ /**
22
+ * XML CDAR à soumettre
23
+ */
24
+ 'xml': string;
25
+ /**
26
+ * Type de flux AFNOR
27
+ */
28
+ 'flowType'?: string;
29
+ 'filename'?: string | null;
30
+ }
31
+
@@ -15,7 +15,7 @@
15
15
 
16
16
  // May contain unused imports in some cases
17
17
  // @ts-ignore
18
- import type { ChorusProCredentials } from './chorus-pro-credentials';
18
+ import type { FactureElectroniqueRestApiSchemasChorusProChorusProCredentials } from './facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials';
19
19
  // May contain unused imports in some cases
20
20
  // @ts-ignore
21
21
  import type { SubmitGrossAmount } from './submit-gross-amount';
@@ -30,7 +30,7 @@ import type { SubmitVatAmount } from './submit-vat-amount';
30
30
  * Submit an invoice to Chorus Pro.
31
31
  */
32
32
  export interface SubmitInvoiceRequest {
33
- 'credentials'?: ChorusProCredentials | null;
33
+ 'credentials'?: FactureElectroniqueRestApiSchemasChorusProChorusProCredentials | null;
34
34
  /**
35
35
  * Invoice number
36
36
  */
@@ -0,0 +1,33 @@
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
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { Encaisseamount1 } from './encaisseamount1';
19
+
20
+ /**
21
+ * Requête de validation CDAR.
22
+ */
23
+ export interface ValidateCDARRequest {
24
+ 'documentId'?: string | null;
25
+ 'senderSiren'?: string | null;
26
+ 'senderRole'?: string | null;
27
+ 'invoiceId'?: string | null;
28
+ 'invoiceIssueDate'?: string | null;
29
+ 'status'?: string | null;
30
+ 'reasonCode'?: string | null;
31
+ 'encaisseAmount'?: Encaisseamount1 | null;
32
+ }
33
+
@@ -0,0 +1,37 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * FactPulse REST API
5
+ * REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://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
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { ValidationErrorResponse } from './validation-error-response';
19
+
20
+ /**
21
+ * Réponse de validation CDAR.
22
+ */
23
+ export interface ValidateCDARResponse {
24
+ /**
25
+ * Résultat de validation
26
+ */
27
+ 'valid': boolean;
28
+ /**
29
+ * Liste des erreurs
30
+ */
31
+ 'errors'?: Array<ValidationErrorResponse>;
32
+ /**
33
+ * Liste des avertissements
34
+ */
35
+ 'warnings'?: Array<ValidationErrorResponse>;
36
+ }
37
+
@@ -15,12 +15,21 @@
15
15
 
16
16
 
17
17
  /**
18
- * Response for validation errors.
18
+ * Erreur de validation.
19
19
  */
20
20
  export interface ValidationErrorResponse {
21
21
  /**
22
- * List of detected validation errors.
22
+ * Champ concerné
23
23
  */
24
- 'detail': Array<string>;
24
+ 'field': string;
25
+ /**
26
+ * Message d\'erreur
27
+ */
28
+ 'message': string;
29
+ 'rule'?: string | null;
30
+ /**
31
+ * Sévérité (error/warning)
32
+ */
33
+ 'severity'?: string;
25
34
  }
26
35