factpulse 2.0.37__py3-none-any.whl → 3.0.7__py3-none-any.whl

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.

Potentially problematic release.


This version of factpulse might be problematic. Click here for more details.

Files changed (262) hide show
  1. factpulse/__init__.py +265 -197
  2. factpulse/api/__init__.py +5 -4
  3. factpulse/api/afnorpdppa_api.py +34 -34
  4. factpulse/api/afnorpdppa_directory_service_api.py +59 -59
  5. factpulse/api/afnorpdppa_flow_service_api.py +23 -23
  6. factpulse/api/chorus_pro_api.py +211 -211
  7. factpulse/api/document_conversion_api.py +1506 -0
  8. factpulse/api/{sant_api.py → health_api.py} +22 -22
  9. factpulse/api/invoice_processing_api.py +3437 -0
  10. factpulse/api/{vrification_pdfxml_api.py → pdfxml_verification_api.py} +240 -240
  11. factpulse/api/{utilisateur_api.py → user_api.py} +17 -17
  12. factpulse/api_client.py +3 -3
  13. factpulse/configuration.py +3 -3
  14. factpulse/exceptions.py +2 -2
  15. factpulse/models/__init__.py +128 -95
  16. factpulse/models/acknowledgment_status.py +38 -0
  17. factpulse/models/additional_document.py +115 -0
  18. factpulse/models/afnor_credentials.py +106 -0
  19. factpulse/models/afnor_destination.py +127 -0
  20. factpulse/models/afnor_health_check_response.py +91 -0
  21. factpulse/models/afnor_result.py +105 -0
  22. factpulse/models/allowance_charge.py +147 -0
  23. factpulse/models/allowance_reason_code.py +42 -0
  24. factpulse/models/allowance_total_amount.py +145 -0
  25. factpulse/models/amount.py +139 -0
  26. factpulse/models/amount_due.py +139 -0
  27. factpulse/models/api_error.py +5 -5
  28. factpulse/models/async_task_status.py +97 -0
  29. factpulse/models/base_amount.py +145 -0
  30. factpulse/models/bounding_box_schema.py +10 -10
  31. factpulse/models/celery_status.py +40 -0
  32. factpulse/models/certificate_info_response.py +24 -24
  33. factpulse/models/charge_total_amount.py +145 -0
  34. factpulse/models/chorus_pro_destination.py +108 -0
  35. factpulse/models/chorus_pro_result.py +101 -0
  36. factpulse/models/contact.py +113 -0
  37. factpulse/models/convert_error_response.py +105 -0
  38. factpulse/models/convert_pending_input_response.py +114 -0
  39. factpulse/models/convert_resume_request.py +87 -0
  40. factpulse/models/convert_success_response.py +126 -0
  41. factpulse/models/convert_validation_failed_response.py +120 -0
  42. factpulse/models/delivery_party.py +121 -0
  43. factpulse/models/destination.py +27 -27
  44. factpulse/models/document_type_info.py +91 -0
  45. factpulse/models/electronic_address.py +90 -0
  46. factpulse/models/enriched_invoice_info.py +133 -0
  47. factpulse/models/error_level.py +2 -2
  48. factpulse/models/error_source.py +2 -2
  49. factpulse/models/extraction_info.py +93 -0
  50. factpulse/models/factur_x_invoice.py +320 -0
  51. factpulse/models/factur_x_profile.py +39 -0
  52. factpulse/models/factur_xpdf_info.py +91 -0
  53. factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.py +95 -0
  54. factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.py +115 -0
  55. factpulse/models/field_status.py +40 -0
  56. factpulse/models/file_info.py +94 -0
  57. factpulse/models/files_info.py +106 -0
  58. factpulse/models/flow_direction.py +37 -0
  59. factpulse/models/flow_profile.py +38 -0
  60. factpulse/models/flow_summary.py +131 -0
  61. factpulse/models/flow_syntax.py +40 -0
  62. factpulse/models/flow_type.py +40 -0
  63. factpulse/models/generate_certificate_request.py +26 -26
  64. factpulse/models/generate_certificate_response.py +15 -15
  65. factpulse/models/get_chorus_pro_id_request.py +100 -0
  66. factpulse/models/get_chorus_pro_id_response.py +98 -0
  67. factpulse/models/get_invoice_request.py +98 -0
  68. factpulse/models/get_invoice_response.py +142 -0
  69. factpulse/models/get_structure_request.py +100 -0
  70. factpulse/models/get_structure_response.py +142 -0
  71. factpulse/models/global_allowance_amount.py +139 -0
  72. factpulse/models/gross_unit_price.py +145 -0
  73. factpulse/models/http_validation_error.py +2 -2
  74. factpulse/models/incoming_invoice.py +196 -0
  75. factpulse/models/incoming_supplier.py +144 -0
  76. factpulse/models/invoice_format.py +38 -0
  77. factpulse/models/invoice_line.py +354 -0
  78. factpulse/models/invoice_line_allowance_amount.py +145 -0
  79. factpulse/models/invoice_note.py +94 -0
  80. factpulse/models/invoice_references.py +194 -0
  81. factpulse/models/invoice_status.py +96 -0
  82. factpulse/models/invoice_totals.py +177 -0
  83. factpulse/models/invoice_totals_prepayment.py +145 -0
  84. factpulse/models/invoice_type_code.py +51 -0
  85. factpulse/models/invoicing_framework.py +110 -0
  86. factpulse/models/invoicing_framework_code.py +39 -0
  87. factpulse/models/line_net_amount.py +145 -0
  88. factpulse/models/line_total_amount.py +145 -0
  89. factpulse/models/mandatory_note_schema.py +124 -0
  90. factpulse/models/manual_rate.py +139 -0
  91. factpulse/models/manual_vat_rate.py +139 -0
  92. factpulse/models/missing_field.py +107 -0
  93. factpulse/models/operation_nature.py +49 -0
  94. factpulse/models/output_format.py +37 -0
  95. factpulse/models/page_dimensions_schema.py +89 -0
  96. factpulse/models/payee.py +168 -0
  97. factpulse/models/payment_card.py +99 -0
  98. factpulse/models/payment_means.py +41 -0
  99. factpulse/models/pdf_validation_result_api.py +169 -0
  100. factpulse/models/pdp_credentials.py +15 -15
  101. factpulse/models/percentage.py +145 -0
  102. factpulse/models/postal_address.py +134 -0
  103. factpulse/models/price_allowance_amount.py +145 -0
  104. factpulse/models/price_basis_quantity.py +145 -0
  105. factpulse/models/processing_options.py +94 -0
  106. factpulse/models/product_characteristic.py +89 -0
  107. factpulse/models/product_classification.py +101 -0
  108. factpulse/models/quantity.py +139 -0
  109. factpulse/models/recipient.py +167 -0
  110. factpulse/models/rounding_amount.py +145 -0
  111. factpulse/models/scheme_id.py +10 -4
  112. factpulse/models/search_flow_request.py +143 -0
  113. factpulse/models/search_flow_response.py +101 -0
  114. factpulse/models/search_services_response.py +101 -0
  115. factpulse/models/search_structure_request.py +119 -0
  116. factpulse/models/search_structure_response.py +101 -0
  117. factpulse/models/signature_info.py +6 -6
  118. factpulse/models/signature_info_api.py +122 -0
  119. factpulse/models/signature_parameters.py +133 -0
  120. factpulse/models/simplified_invoice_data.py +124 -0
  121. factpulse/models/structure_info.py +14 -14
  122. factpulse/models/structure_parameters.py +91 -0
  123. factpulse/models/structure_service.py +93 -0
  124. factpulse/models/submission_mode.py +38 -0
  125. factpulse/models/submit_complete_invoice_request.py +116 -0
  126. factpulse/models/submit_complete_invoice_response.py +145 -0
  127. factpulse/models/submit_flow_request.py +123 -0
  128. factpulse/models/submit_flow_response.py +109 -0
  129. factpulse/models/submit_gross_amount.py +139 -0
  130. factpulse/models/submit_invoice_request.py +176 -0
  131. factpulse/models/submit_invoice_response.py +103 -0
  132. factpulse/models/submit_net_amount.py +139 -0
  133. factpulse/models/submit_vat_amount.py +139 -0
  134. factpulse/models/supplementary_attachment.py +95 -0
  135. factpulse/models/supplier.py +225 -0
  136. factpulse/models/task_response.py +87 -0
  137. factpulse/models/tax_representative.py +95 -0
  138. factpulse/models/taxable_amount.py +139 -0
  139. factpulse/models/total_gross_amount.py +139 -0
  140. factpulse/models/total_net_amount.py +139 -0
  141. factpulse/models/total_vat_amount.py +139 -0
  142. factpulse/models/unit_net_price.py +139 -0
  143. factpulse/models/unit_of_measure.py +41 -0
  144. factpulse/models/validation_error.py +2 -2
  145. factpulse/models/validation_error_detail.py +6 -6
  146. factpulse/models/validation_error_loc_inner.py +2 -2
  147. factpulse/models/validation_error_response.py +87 -0
  148. factpulse/models/validation_info.py +105 -0
  149. factpulse/models/validation_success_response.py +87 -0
  150. factpulse/models/vat_accounting_code.py +39 -0
  151. factpulse/models/vat_amount.py +139 -0
  152. factpulse/models/vat_category.py +44 -0
  153. factpulse/models/vat_line.py +140 -0
  154. factpulse/models/vat_point_date_code.py +38 -0
  155. factpulse/models/vat_rate.py +145 -0
  156. factpulse/models/verification_success_response.py +135 -0
  157. factpulse/models/verified_field_schema.py +129 -0
  158. factpulse/rest.py +2 -2
  159. factpulse-3.0.7.dist-info/METADATA +292 -0
  160. factpulse-3.0.7.dist-info/RECORD +168 -0
  161. factpulse_helpers/__init__.py +34 -34
  162. factpulse_helpers/client.py +1019 -795
  163. factpulse_helpers/exceptions.py +68 -68
  164. factpulse/api/traitement_facture_api.py +0 -3437
  165. factpulse/models/adresse_electronique.py +0 -90
  166. factpulse/models/adresse_postale.py +0 -120
  167. factpulse/models/cadre_de_facturation.py +0 -110
  168. factpulse/models/categorie_tva.py +0 -44
  169. factpulse/models/champ_verifie_schema.py +0 -129
  170. factpulse/models/chorus_pro_credentials.py +0 -95
  171. factpulse/models/code_cadre_facturation.py +0 -39
  172. factpulse/models/code_raison_reduction.py +0 -42
  173. factpulse/models/consulter_facture_request.py +0 -98
  174. factpulse/models/consulter_facture_response.py +0 -142
  175. factpulse/models/consulter_structure_request.py +0 -100
  176. factpulse/models/consulter_structure_response.py +0 -142
  177. factpulse/models/credentials_afnor.py +0 -106
  178. factpulse/models/credentials_chorus_pro.py +0 -115
  179. factpulse/models/destinataire.py +0 -130
  180. factpulse/models/destination_afnor.py +0 -127
  181. factpulse/models/destination_chorus_pro.py +0 -108
  182. factpulse/models/dimension_page_schema.py +0 -89
  183. factpulse/models/direction_flux.py +0 -37
  184. factpulse/models/donnees_facture_simplifiees.py +0 -124
  185. factpulse/models/facture_enrichie_info.py +0 -133
  186. factpulse/models/facture_entrante.py +0 -196
  187. factpulse/models/facture_factur_x.py +0 -183
  188. factpulse/models/flux_resume.py +0 -131
  189. factpulse/models/format_facture.py +0 -38
  190. factpulse/models/format_sortie.py +0 -37
  191. factpulse/models/fournisseur.py +0 -153
  192. factpulse/models/fournisseur_entrant.py +0 -144
  193. factpulse/models/information_signature_api.py +0 -122
  194. factpulse/models/ligne_de_poste.py +0 -183
  195. factpulse/models/ligne_de_poste_montant_remise_ht.py +0 -145
  196. factpulse/models/ligne_de_poste_taux_tva_manuel.py +0 -145
  197. factpulse/models/ligne_de_tva.py +0 -132
  198. factpulse/models/mode_depot.py +0 -38
  199. factpulse/models/mode_paiement.py +0 -41
  200. factpulse/models/montant_a_payer.py +0 -139
  201. factpulse/models/montant_base_ht.py +0 -139
  202. factpulse/models/montant_ht_total.py +0 -139
  203. factpulse/models/montant_remise_globale_ttc.py +0 -139
  204. factpulse/models/montant_total.py +0 -133
  205. factpulse/models/montant_total_acompte.py +0 -145
  206. factpulse/models/montant_total_ligne_ht.py +0 -139
  207. factpulse/models/montant_ttc_total.py +0 -139
  208. factpulse/models/montant_tva.py +0 -139
  209. factpulse/models/montant_tva_ligne.py +0 -139
  210. factpulse/models/montant_tva_total.py +0 -139
  211. factpulse/models/montant_unitaire_ht.py +0 -139
  212. factpulse/models/nature_operation.py +0 -49
  213. factpulse/models/note.py +0 -94
  214. factpulse/models/note_obligatoire_schema.py +0 -124
  215. factpulse/models/obtenir_id_chorus_pro_request.py +0 -100
  216. factpulse/models/obtenir_id_chorus_pro_response.py +0 -98
  217. factpulse/models/options_processing.py +0 -94
  218. factpulse/models/parametres_signature.py +0 -133
  219. factpulse/models/parametres_structure.py +0 -91
  220. factpulse/models/pdf_factur_x_info.py +0 -91
  221. factpulse/models/piece_jointe_complementaire.py +0 -95
  222. factpulse/models/profil_api.py +0 -39
  223. factpulse/models/profil_flux.py +0 -38
  224. factpulse/models/quantite.py +0 -139
  225. factpulse/models/rechercher_services_response.py +0 -101
  226. factpulse/models/rechercher_structure_request.py +0 -119
  227. factpulse/models/rechercher_structure_response.py +0 -101
  228. factpulse/models/references.py +0 -124
  229. factpulse/models/reponse_healthcheck_afnor.py +0 -91
  230. factpulse/models/reponse_recherche_flux.py +0 -101
  231. factpulse/models/reponse_soumission_flux.py +0 -109
  232. factpulse/models/reponse_tache.py +0 -87
  233. factpulse/models/reponse_validation_erreur.py +0 -87
  234. factpulse/models/reponse_validation_succes.py +0 -87
  235. factpulse/models/reponse_verification_succes.py +0 -135
  236. factpulse/models/requete_recherche_flux.py +0 -143
  237. factpulse/models/requete_soumission_flux.py +0 -123
  238. factpulse/models/resultat_afnor.py +0 -105
  239. factpulse/models/resultat_chorus_pro.py +0 -101
  240. factpulse/models/resultat_validation_pdfapi.py +0 -169
  241. factpulse/models/service_structure.py +0 -93
  242. factpulse/models/soumettre_facture_complete_request.py +0 -116
  243. factpulse/models/soumettre_facture_complete_response.py +0 -145
  244. factpulse/models/soumettre_facture_request.py +0 -176
  245. factpulse/models/soumettre_facture_response.py +0 -103
  246. factpulse/models/statut_acquittement.py +0 -38
  247. factpulse/models/statut_celery.py +0 -40
  248. factpulse/models/statut_champ_api.py +0 -40
  249. factpulse/models/statut_facture.py +0 -96
  250. factpulse/models/statut_tache.py +0 -97
  251. factpulse/models/syntaxe_flux.py +0 -40
  252. factpulse/models/tauxmanuel.py +0 -139
  253. factpulse/models/type_document.py +0 -40
  254. factpulse/models/type_facture.py +0 -37
  255. factpulse/models/type_flux.py +0 -40
  256. factpulse/models/type_tva.py +0 -39
  257. factpulse/models/unite.py +0 -41
  258. factpulse-2.0.37.dist-info/METADATA +0 -292
  259. factpulse-2.0.37.dist-info/RECORD +0 -134
  260. {factpulse-2.0.37.dist-info → factpulse-3.0.7.dist-info}/WHEEL +0 -0
  261. {factpulse-2.0.37.dist-info → factpulse-3.0.7.dist-info}/licenses/LICENSE +0 -0
  262. {factpulse-2.0.37.dist-info → factpulse-3.0.7.dist-info}/top_level.txt +0 -0
@@ -2,9 +2,9 @@
2
2
 
3
3
  # flake8: noqa
4
4
  """
5
- API REST FactPulse
5
+ FactPulse REST API
6
6
 
7
- API REST pour la facturation électronique en France : Factur-X, AFNOR PDP/PA, signatures électroniques. ## 🎯 Fonctionnalités principales ### 📄 Génération de factures Factur-X - **Formats** : XML seul ou PDF/A-3 avec XML embarqué - **Profils** : MINIMUM, BASIC, EN16931, EXTENDED - **Normes** : EN 16931 (directive UE 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Format simplifié** : Génération à partir de SIRET + auto-enrichissement (API Chorus Pro + Recherche Entreprises) ### ✅ Validation et conformité - **Validation XML** : Schematron (45 à 210+ règles selon profil) - **Validation PDF** : PDF/A-3, métadonnées XMP Factur-X, signatures électroniques - **VeraPDF** : Validation stricte PDF/A (146+ règles ISO 19005-3) - **Traitement asynchrone** : Support Celery pour validations lourdes (VeraPDF) ### 📡 Intégration AFNOR PDP/PA (XP Z12-013) - **Soumission de flux** : Envoi de factures vers Plateformes de Dématérialisation Partenaires - **Recherche de flux** : Consultation des factures soumises - **Téléchargement** : Récupération des PDF/A-3 avec XML - **Directory Service** : Recherche d'entreprises (SIREN/SIRET) - **Multi-client** : Support de plusieurs configs PDP par utilisateur (stored credentials ou zero-storage) ### ✍️ Signature électronique PDF - **Standards** : PAdES-B-B, PAdES-B-T (horodatage RFC 3161), PAdES-B-LT (archivage long terme) - **Niveaux eIDAS** : SES (auto-signé), AdES (CA commerciale), QES (PSCO) - **Validation** : Vérification intégrité cryptographique et certificats - **Génération de certificats** : Certificats X.509 auto-signés pour tests ### 🔄 Traitement asynchrone - **Celery** : Génération, validation et signature asynchrones - **Polling** : Suivi d'état via `/taches/{id_tache}/statut` - **Pas de timeout** : Idéal pour gros fichiers ou validations lourdes ## 🔒 Authentification Toutes les requêtes nécessitent un **token JWT** dans le header Authorization : ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### Comment obtenir un token JWT ? #### 🔑 Méthode 1 : API `/api/token/` (Recommandée) **URL :** `https://www.factpulse.fr/api/token/` Cette méthode est **recommandée** pour l'intégration dans vos applications et workflows CI/CD. **Prérequis :** Avoir défini un mot de passe sur votre compte **Pour les utilisateurs inscrits via email/password :** - Vous avez déjà un mot de passe, utilisez-le directement **Pour les utilisateurs inscrits via OAuth (Google/GitHub) :** - Vous devez d'abord définir un mot de passe sur : https://www.factpulse.fr/accounts/password/set/ - Une fois le mot de passe créé, vous pourrez utiliser l'API **Exemple de requête :** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"votre_email@example.com\", \"password\": \"votre_mot_de_passe\" }' ``` **Paramètre optionnel `client_uid` :** Pour sélectionner les credentials d'un client spécifique (PA/PDP, Chorus Pro, certificats de signature), ajoutez `client_uid` : ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"votre_email@example.com\", \"password\": \"votre_mot_de_passe\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` Le `client_uid` sera inclus dans le JWT et permettra à l'API d'utiliser automatiquement : - Les credentials AFNOR/PDP configurés pour ce client - Les credentials Chorus Pro configurés pour ce client - Les certificats de signature électronique configurés pour ce client **Réponse :** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Token d'accès (validité: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Token de rafraîchissement (validité: 7 jours) } ``` **Avantages :** - ✅ Automatisation complète (CI/CD, scripts) - ✅ Gestion programmatique des tokens - ✅ Support du refresh token pour renouveler automatiquement l'accès - ✅ Intégration facile dans n'importe quel langage/outil #### 🖥️ Méthode 2 : Génération via Dashboard (Alternative) **URL :** https://www.factpulse.fr/dashboard/ Cette méthode convient pour des tests rapides ou une utilisation occasionnelle via l'interface graphique. **Fonctionnement :** - Connectez-vous au dashboard - Utilisez les boutons \"Generate Test Token\" ou \"Generate Production Token\" - Fonctionne pour **tous** les utilisateurs (OAuth et email/password), sans nécessiter de mot de passe **Types de tokens :** - **Token Test** : Validité 24h, quota 1000 appels/jour (gratuit) - **Token Production** : Validité 7 jours, quota selon votre forfait **Avantages :** - ✅ Rapide pour tester l'API - ✅ Aucun mot de passe requis - ✅ Interface visuelle simple **Inconvénients :** - ❌ Nécessite une action manuelle - ❌ Pas de refresh token - ❌ Moins adapté pour l'automatisation ### 📚 Documentation complète Pour plus d'informations sur l'authentification et l'utilisation de l'API : https://www.factpulse.fr/documentation-api/
7
+ REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
8
8
 
9
9
  The version of the OpenAPI document: 1.0.0
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -13,113 +13,146 @@
13
13
  """ # noqa: E501
14
14
 
15
15
  # import models into model package
16
+ from factpulse.models.afnor_credentials import AFNORCredentials
17
+ from factpulse.models.afnor_destination import AFNORDestination
18
+ from factpulse.models.afnor_health_check_response import AFNORHealthCheckResponse
19
+ from factpulse.models.afnor_result import AFNORResult
16
20
  from factpulse.models.api_error import APIError
17
- from factpulse.models.adresse_electronique import AdresseElectronique
18
- from factpulse.models.adresse_postale import AdressePostale
21
+ from factpulse.models.acknowledgment_status import AcknowledgmentStatus
22
+ from factpulse.models.additional_document import AdditionalDocument
23
+ from factpulse.models.allowance_charge import AllowanceCharge
24
+ from factpulse.models.allowance_reason_code import AllowanceReasonCode
25
+ from factpulse.models.allowance_total_amount import AllowanceTotalAmount
26
+ from factpulse.models.amount import Amount
27
+ from factpulse.models.amount_due import AmountDue
28
+ from factpulse.models.async_task_status import AsyncTaskStatus
29
+ from factpulse.models.base_amount import BaseAmount
19
30
  from factpulse.models.bounding_box_schema import BoundingBoxSchema
20
- from factpulse.models.cadre_de_facturation import CadreDeFacturation
21
- from factpulse.models.categorie_tva import CategorieTVA
31
+ from factpulse.models.celery_status import CeleryStatus
22
32
  from factpulse.models.certificate_info_response import CertificateInfoResponse
23
- from factpulse.models.champ_verifie_schema import ChampVerifieSchema
24
- from factpulse.models.chorus_pro_credentials import ChorusProCredentials
25
- from factpulse.models.code_cadre_facturation import CodeCadreFacturation
26
- from factpulse.models.code_raison_reduction import CodeRaisonReduction
27
- from factpulse.models.consulter_facture_request import ConsulterFactureRequest
28
- from factpulse.models.consulter_facture_response import ConsulterFactureResponse
29
- from factpulse.models.consulter_structure_request import ConsulterStructureRequest
30
- from factpulse.models.consulter_structure_response import ConsulterStructureResponse
31
- from factpulse.models.credentials_afnor import CredentialsAFNOR
32
- from factpulse.models.credentials_chorus_pro import CredentialsChorusPro
33
- from factpulse.models.destinataire import Destinataire
33
+ from factpulse.models.charge_total_amount import ChargeTotalAmount
34
+ from factpulse.models.chorus_pro_destination import ChorusProDestination
35
+ from factpulse.models.chorus_pro_result import ChorusProResult
36
+ from factpulse.models.contact import Contact
37
+ from factpulse.models.convert_error_response import ConvertErrorResponse
38
+ from factpulse.models.convert_pending_input_response import ConvertPendingInputResponse
39
+ from factpulse.models.convert_resume_request import ConvertResumeRequest
40
+ from factpulse.models.convert_success_response import ConvertSuccessResponse
41
+ from factpulse.models.convert_validation_failed_response import ConvertValidationFailedResponse
42
+ from factpulse.models.delivery_party import DeliveryParty
34
43
  from factpulse.models.destination import Destination
35
- from factpulse.models.destination_afnor import DestinationAFNOR
36
- from factpulse.models.destination_chorus_pro import DestinationChorusPro
37
- from factpulse.models.dimension_page_schema import DimensionPageSchema
38
- from factpulse.models.direction_flux import DirectionFlux
39
- from factpulse.models.donnees_facture_simplifiees import DonneesFactureSimplifiees
44
+ from factpulse.models.document_type_info import DocumentTypeInfo
45
+ from factpulse.models.electronic_address import ElectronicAddress
46
+ from factpulse.models.enriched_invoice_info import EnrichedInvoiceInfo
40
47
  from factpulse.models.error_level import ErrorLevel
41
48
  from factpulse.models.error_source import ErrorSource
42
- from factpulse.models.facture_enrichie_info import FactureEnrichieInfo
43
- from factpulse.models.facture_entrante import FactureEntrante
44
- from factpulse.models.facture_factur_x import FactureFacturX
45
- from factpulse.models.flux_resume import FluxResume
46
- from factpulse.models.format_facture import FormatFacture
47
- from factpulse.models.format_sortie import FormatSortie
48
- from factpulse.models.fournisseur import Fournisseur
49
- from factpulse.models.fournisseur_entrant import FournisseurEntrant
49
+ from factpulse.models.extraction_info import ExtractionInfo
50
+ from factpulse.models.factur_x_invoice import FacturXInvoice
51
+ from factpulse.models.factur_xpdf_info import FacturXPDFInfo
52
+ from factpulse.models.factur_x_profile import FacturXProfile
53
+ from factpulse.models.facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials import FactureElectroniqueRestApiSchemasChorusProChorusProCredentials
54
+ from factpulse.models.facture_electronique_rest_api_schemas_processing_chorus_pro_credentials import FactureElectroniqueRestApiSchemasProcessingChorusProCredentials
55
+ from factpulse.models.field_status import FieldStatus
56
+ from factpulse.models.file_info import FileInfo
57
+ from factpulse.models.files_info import FilesInfo
58
+ from factpulse.models.flow_direction import FlowDirection
59
+ from factpulse.models.flow_profile import FlowProfile
60
+ from factpulse.models.flow_summary import FlowSummary
61
+ from factpulse.models.flow_syntax import FlowSyntax
62
+ from factpulse.models.flow_type import FlowType
50
63
  from factpulse.models.generate_certificate_request import GenerateCertificateRequest
51
64
  from factpulse.models.generate_certificate_response import GenerateCertificateResponse
65
+ from factpulse.models.get_chorus_pro_id_request import GetChorusProIdRequest
66
+ from factpulse.models.get_chorus_pro_id_response import GetChorusProIdResponse
67
+ from factpulse.models.get_invoice_request import GetInvoiceRequest
68
+ from factpulse.models.get_invoice_response import GetInvoiceResponse
69
+ from factpulse.models.get_structure_request import GetStructureRequest
70
+ from factpulse.models.get_structure_response import GetStructureResponse
71
+ from factpulse.models.global_allowance_amount import GlobalAllowanceAmount
72
+ from factpulse.models.gross_unit_price import GrossUnitPrice
52
73
  from factpulse.models.http_validation_error import HTTPValidationError
53
- from factpulse.models.information_signature_api import InformationSignatureAPI
54
- from factpulse.models.ligne_de_poste import LigneDePoste
55
- from factpulse.models.ligne_de_poste_montant_remise_ht import LigneDePosteMontantRemiseHt
56
- from factpulse.models.ligne_de_poste_taux_tva_manuel import LigneDePosteTauxTvaManuel
57
- from factpulse.models.ligne_de_tva import LigneDeTVA
58
- from factpulse.models.mode_depot import ModeDepot
59
- from factpulse.models.mode_paiement import ModePaiement
60
- from factpulse.models.montant_a_payer import MontantAPayer
61
- from factpulse.models.montant_base_ht import MontantBaseHt
62
- from factpulse.models.montant_ht_total import MontantHtTotal
63
- from factpulse.models.montant_remise_globale_ttc import MontantRemiseGlobaleTtc
64
- from factpulse.models.montant_total import MontantTotal
65
- from factpulse.models.montant_total_acompte import MontantTotalAcompte
66
- from factpulse.models.montant_total_ligne_ht import MontantTotalLigneHt
67
- from factpulse.models.montant_ttc_total import MontantTtcTotal
68
- from factpulse.models.montant_tva import MontantTva
69
- from factpulse.models.montant_tva_ligne import MontantTvaLigne
70
- from factpulse.models.montant_tva_total import MontantTvaTotal
71
- from factpulse.models.montant_unitaire_ht import MontantUnitaireHt
72
- from factpulse.models.nature_operation import NatureOperation
73
- from factpulse.models.note import Note
74
- from factpulse.models.note_obligatoire_schema import NoteObligatoireSchema
75
- from factpulse.models.obtenir_id_chorus_pro_request import ObtenirIdChorusProRequest
76
- from factpulse.models.obtenir_id_chorus_pro_response import ObtenirIdChorusProResponse
77
- from factpulse.models.options_processing import OptionsProcessing
78
- from factpulse.models.pdf_factur_x_info import PDFFacturXInfo
74
+ from factpulse.models.incoming_invoice import IncomingInvoice
75
+ from factpulse.models.incoming_supplier import IncomingSupplier
76
+ from factpulse.models.invoice_format import InvoiceFormat
77
+ from factpulse.models.invoice_line import InvoiceLine
78
+ from factpulse.models.invoice_line_allowance_amount import InvoiceLineAllowanceAmount
79
+ from factpulse.models.invoice_note import InvoiceNote
80
+ from factpulse.models.invoice_references import InvoiceReferences
81
+ from factpulse.models.invoice_status import InvoiceStatus
82
+ from factpulse.models.invoice_totals import InvoiceTotals
83
+ from factpulse.models.invoice_totals_prepayment import InvoiceTotalsPrepayment
84
+ from factpulse.models.invoice_type_code import InvoiceTypeCode
85
+ from factpulse.models.invoicing_framework import InvoicingFramework
86
+ from factpulse.models.invoicing_framework_code import InvoicingFrameworkCode
87
+ from factpulse.models.line_net_amount import LineNetAmount
88
+ from factpulse.models.line_total_amount import LineTotalAmount
89
+ from factpulse.models.mandatory_note_schema import MandatoryNoteSchema
90
+ from factpulse.models.manual_rate import ManualRate
91
+ from factpulse.models.manual_vat_rate import ManualVatRate
92
+ from factpulse.models.missing_field import MissingField
93
+ from factpulse.models.operation_nature import OperationNature
94
+ from factpulse.models.output_format import OutputFormat
95
+ from factpulse.models.pdf_validation_result_api import PDFValidationResultAPI
79
96
  from factpulse.models.pdp_credentials import PDPCredentials
80
- from factpulse.models.parametres_signature import ParametresSignature
81
- from factpulse.models.parametres_structure import ParametresStructure
82
- from factpulse.models.piece_jointe_complementaire import PieceJointeComplementaire
83
- from factpulse.models.profil_api import ProfilAPI
84
- from factpulse.models.profil_flux import ProfilFlux
85
- from factpulse.models.quantite import Quantite
86
- from factpulse.models.rechercher_services_response import RechercherServicesResponse
87
- from factpulse.models.rechercher_structure_request import RechercherStructureRequest
88
- from factpulse.models.rechercher_structure_response import RechercherStructureResponse
89
- from factpulse.models.references import References
90
- from factpulse.models.reponse_healthcheck_afnor import ReponseHealthcheckAFNOR
91
- from factpulse.models.reponse_recherche_flux import ReponseRechercheFlux
92
- from factpulse.models.reponse_soumission_flux import ReponseSoumissionFlux
93
- from factpulse.models.reponse_tache import ReponseTache
94
- from factpulse.models.reponse_validation_erreur import ReponseValidationErreur
95
- from factpulse.models.reponse_validation_succes import ReponseValidationSucces
96
- from factpulse.models.reponse_verification_succes import ReponseVerificationSucces
97
- from factpulse.models.requete_recherche_flux import RequeteRechercheFlux
98
- from factpulse.models.requete_soumission_flux import RequeteSoumissionFlux
99
- from factpulse.models.resultat_afnor import ResultatAFNOR
100
- from factpulse.models.resultat_chorus_pro import ResultatChorusPro
101
- from factpulse.models.resultat_validation_pdfapi import ResultatValidationPDFAPI
97
+ from factpulse.models.page_dimensions_schema import PageDimensionsSchema
98
+ from factpulse.models.payee import Payee
99
+ from factpulse.models.payment_card import PaymentCard
100
+ from factpulse.models.payment_means import PaymentMeans
101
+ from factpulse.models.percentage import Percentage
102
+ from factpulse.models.postal_address import PostalAddress
103
+ from factpulse.models.price_allowance_amount import PriceAllowanceAmount
104
+ from factpulse.models.price_basis_quantity import PriceBasisQuantity
105
+ from factpulse.models.processing_options import ProcessingOptions
106
+ from factpulse.models.product_characteristic import ProductCharacteristic
107
+ from factpulse.models.product_classification import ProductClassification
108
+ from factpulse.models.quantity import Quantity
109
+ from factpulse.models.recipient import Recipient
110
+ from factpulse.models.rounding_amount import RoundingAmount
102
111
  from factpulse.models.scheme_id import SchemeID
103
- from factpulse.models.service_structure import ServiceStructure
112
+ from factpulse.models.search_flow_request import SearchFlowRequest
113
+ from factpulse.models.search_flow_response import SearchFlowResponse
114
+ from factpulse.models.search_services_response import SearchServicesResponse
115
+ from factpulse.models.search_structure_request import SearchStructureRequest
116
+ from factpulse.models.search_structure_response import SearchStructureResponse
104
117
  from factpulse.models.signature_info import SignatureInfo
105
- from factpulse.models.soumettre_facture_complete_request import SoumettreFactureCompleteRequest
106
- from factpulse.models.soumettre_facture_complete_response import SoumettreFactureCompleteResponse
107
- from factpulse.models.soumettre_facture_request import SoumettreFactureRequest
108
- from factpulse.models.soumettre_facture_response import SoumettreFactureResponse
109
- from factpulse.models.statut_acquittement import StatutAcquittement
110
- from factpulse.models.statut_celery import StatutCelery
111
- from factpulse.models.statut_champ_api import StatutChampAPI
112
- from factpulse.models.statut_facture import StatutFacture
113
- from factpulse.models.statut_tache import StatutTache
118
+ from factpulse.models.signature_info_api import SignatureInfoAPI
119
+ from factpulse.models.signature_parameters import SignatureParameters
120
+ from factpulse.models.simplified_invoice_data import SimplifiedInvoiceData
114
121
  from factpulse.models.structure_info import StructureInfo
115
- from factpulse.models.syntaxe_flux import SyntaxeFlux
116
- from factpulse.models.tauxmanuel import Tauxmanuel
117
- from factpulse.models.type_document import TypeDocument
118
- from factpulse.models.type_facture import TypeFacture
119
- from factpulse.models.type_flux import TypeFlux
120
- from factpulse.models.type_tva import TypeTVA
121
- from factpulse.models.unite import Unite
122
+ from factpulse.models.structure_parameters import StructureParameters
123
+ from factpulse.models.structure_service import StructureService
124
+ from factpulse.models.submission_mode import SubmissionMode
125
+ from factpulse.models.submit_complete_invoice_request import SubmitCompleteInvoiceRequest
126
+ from factpulse.models.submit_complete_invoice_response import SubmitCompleteInvoiceResponse
127
+ from factpulse.models.submit_flow_request import SubmitFlowRequest
128
+ from factpulse.models.submit_flow_response import SubmitFlowResponse
129
+ from factpulse.models.submit_gross_amount import SubmitGrossAmount
130
+ from factpulse.models.submit_invoice_request import SubmitInvoiceRequest
131
+ from factpulse.models.submit_invoice_response import SubmitInvoiceResponse
132
+ from factpulse.models.submit_net_amount import SubmitNetAmount
133
+ from factpulse.models.submit_vat_amount import SubmitVatAmount
134
+ from factpulse.models.supplementary_attachment import SupplementaryAttachment
135
+ from factpulse.models.supplier import Supplier
136
+ from factpulse.models.task_response import TaskResponse
137
+ from factpulse.models.tax_representative import TaxRepresentative
138
+ from factpulse.models.taxable_amount import TaxableAmount
139
+ from factpulse.models.total_gross_amount import TotalGrossAmount
140
+ from factpulse.models.total_net_amount import TotalNetAmount
141
+ from factpulse.models.total_vat_amount import TotalVATAmount
142
+ from factpulse.models.unit_net_price import UnitNetPrice
143
+ from factpulse.models.unit_of_measure import UnitOfMeasure
144
+ from factpulse.models.vat_accounting_code import VATAccountingCode
145
+ from factpulse.models.vat_amount import VATAmount
146
+ from factpulse.models.vat_category import VATCategory
147
+ from factpulse.models.vat_line import VATLine
148
+ from factpulse.models.vat_point_date_code import VATPointDateCode
122
149
  from factpulse.models.validation_error import ValidationError
123
150
  from factpulse.models.validation_error_detail import ValidationErrorDetail
124
151
  from factpulse.models.validation_error_loc_inner import ValidationErrorLocInner
152
+ from factpulse.models.validation_error_response import ValidationErrorResponse
153
+ from factpulse.models.validation_info import ValidationInfo
154
+ from factpulse.models.validation_success_response import ValidationSuccessResponse
155
+ from factpulse.models.vat_rate import VatRate
156
+ from factpulse.models.verification_success_response import VerificationSuccessResponse
157
+ from factpulse.models.verified_field_schema import VerifiedFieldSchema
125
158
 
@@ -0,0 +1,38 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ FactPulse REST API
5
+
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://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
7
+
8
+ The version of the OpenAPI document: 1.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import json
17
+ from enum import Enum
18
+ from typing_extensions import Self
19
+
20
+
21
+ class AcknowledgmentStatus(str, Enum):
22
+ """
23
+ Flow acknowledgment status.
24
+ """
25
+
26
+ """
27
+ allowed enum values
28
+ """
29
+ PENDING = 'Pending'
30
+ OK = 'Ok'
31
+ ERROR = 'Error'
32
+
33
+ @classmethod
34
+ def from_json(cls, json_str: str) -> Self:
35
+ """Create an instance of AcknowledgmentStatus from a JSON string"""
36
+ return cls(json.loads(json_str))
37
+
38
+
@@ -0,0 +1,115 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ FactPulse REST API
5
+
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://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
7
+
8
+ The version of the OpenAPI document: 1.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictStr
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
+ from typing import Optional, Set
23
+ from typing_extensions import Self
24
+
25
+ class AdditionalDocument(BaseModel):
26
+ """
27
+ Additional supporting document (BG-24). References to external documents or embedded attachments.
28
+ """ # noqa: E501
29
+ id: StrictStr = Field(description="Document reference identifier (BT-122).")
30
+ type_code: Optional[StrictStr] = None
31
+ name: Optional[StrictStr] = None
32
+ uri: Optional[StrictStr] = None
33
+ reference_type_code: Optional[StrictStr] = None
34
+ __properties: ClassVar[List[str]] = ["id", "type_code", "name", "uri", "reference_type_code"]
35
+
36
+ model_config = ConfigDict(
37
+ populate_by_name=True,
38
+ validate_assignment=True,
39
+ protected_namespaces=(),
40
+ )
41
+
42
+
43
+ def to_str(self) -> str:
44
+ """Returns the string representation of the model using alias"""
45
+ return pprint.pformat(self.model_dump(by_alias=True))
46
+
47
+ def to_json(self) -> str:
48
+ """Returns the JSON representation of the model using alias"""
49
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
50
+ return json.dumps(self.to_dict())
51
+
52
+ @classmethod
53
+ def from_json(cls, json_str: str) -> Optional[Self]:
54
+ """Create an instance of AdditionalDocument from a JSON string"""
55
+ return cls.from_dict(json.loads(json_str))
56
+
57
+ def to_dict(self) -> Dict[str, Any]:
58
+ """Return the dictionary representation of the model using alias.
59
+
60
+ This has the following differences from calling pydantic's
61
+ `self.model_dump(by_alias=True)`:
62
+
63
+ * `None` is only added to the output dict for nullable fields that
64
+ were set at model initialization. Other fields with value `None`
65
+ are ignored.
66
+ """
67
+ excluded_fields: Set[str] = set([
68
+ ])
69
+
70
+ _dict = self.model_dump(
71
+ by_alias=True,
72
+ exclude=excluded_fields,
73
+ exclude_none=True,
74
+ )
75
+ # set to None if type_code (nullable) is None
76
+ # and model_fields_set contains the field
77
+ if self.type_code is None and "type_code" in self.model_fields_set:
78
+ _dict['type_code'] = None
79
+
80
+ # set to None if name (nullable) is None
81
+ # and model_fields_set contains the field
82
+ if self.name is None and "name" in self.model_fields_set:
83
+ _dict['name'] = None
84
+
85
+ # set to None if uri (nullable) is None
86
+ # and model_fields_set contains the field
87
+ if self.uri is None and "uri" in self.model_fields_set:
88
+ _dict['uri'] = None
89
+
90
+ # set to None if reference_type_code (nullable) is None
91
+ # and model_fields_set contains the field
92
+ if self.reference_type_code is None and "reference_type_code" in self.model_fields_set:
93
+ _dict['reference_type_code'] = None
94
+
95
+ return _dict
96
+
97
+ @classmethod
98
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
99
+ """Create an instance of AdditionalDocument from a dict"""
100
+ if obj is None:
101
+ return None
102
+
103
+ if not isinstance(obj, dict):
104
+ return cls.model_validate(obj)
105
+
106
+ _obj = cls.model_validate({
107
+ "id": obj.get("id"),
108
+ "type_code": obj.get("type_code"),
109
+ "name": obj.get("name"),
110
+ "uri": obj.get("uri"),
111
+ "reference_type_code": obj.get("reference_type_code")
112
+ })
113
+ return _obj
114
+
115
+
@@ -0,0 +1,106 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ FactPulse REST API
5
+
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://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
7
+
8
+ The version of the OpenAPI document: 1.0.0
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+
15
+ from __future__ import annotations
16
+ import pprint
17
+ import re # noqa: F401
18
+ import json
19
+
20
+ from pydantic import BaseModel, ConfigDict, Field, StrictStr
21
+ from typing import Any, ClassVar, Dict, List, Optional
22
+ from typing import Optional, Set
23
+ from typing_extensions import Self
24
+
25
+ class AFNORCredentials(BaseModel):
26
+ """
27
+ Optional AFNOR PDP credentials. **MODE 1 - JWT retrieval (recommended):** Do not provide this `credentials` field in the payload. PDP credentials will be automatically retrieved via client_uid from JWT (0-trust). **MODE 2 - Credentials in payload (zero-storage):** Provide all required fields below. Useful for tests or third-party integrations.
28
+ """ # noqa: E501
29
+ client_id: Optional[StrictStr] = Field(default=None, alias="clientId")
30
+ client_secret: Optional[StrictStr] = Field(default=None, alias="clientSecret")
31
+ flow_service_url: Optional[StrictStr] = Field(default=None, alias="flowServiceUrl")
32
+ __properties: ClassVar[List[str]] = ["clientId", "clientSecret", "flowServiceUrl"]
33
+
34
+ model_config = ConfigDict(
35
+ populate_by_name=True,
36
+ validate_assignment=True,
37
+ protected_namespaces=(),
38
+ )
39
+
40
+
41
+ def to_str(self) -> str:
42
+ """Returns the string representation of the model using alias"""
43
+ return pprint.pformat(self.model_dump(by_alias=True))
44
+
45
+ def to_json(self) -> str:
46
+ """Returns the JSON representation of the model using alias"""
47
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
48
+ return json.dumps(self.to_dict())
49
+
50
+ @classmethod
51
+ def from_json(cls, json_str: str) -> Optional[Self]:
52
+ """Create an instance of AFNORCredentials from a JSON string"""
53
+ return cls.from_dict(json.loads(json_str))
54
+
55
+ def to_dict(self) -> Dict[str, Any]:
56
+ """Return the dictionary representation of the model using alias.
57
+
58
+ This has the following differences from calling pydantic's
59
+ `self.model_dump(by_alias=True)`:
60
+
61
+ * `None` is only added to the output dict for nullable fields that
62
+ were set at model initialization. Other fields with value `None`
63
+ are ignored.
64
+ """
65
+ excluded_fields: Set[str] = set([
66
+ ])
67
+
68
+ _dict = self.model_dump(
69
+ by_alias=True,
70
+ exclude=excluded_fields,
71
+ exclude_none=True,
72
+ )
73
+ # set to None if client_id (nullable) is None
74
+ # and model_fields_set contains the field
75
+ if self.client_id is None and "client_id" in self.model_fields_set:
76
+ _dict['clientId'] = None
77
+
78
+ # set to None if client_secret (nullable) is None
79
+ # and model_fields_set contains the field
80
+ if self.client_secret is None and "client_secret" in self.model_fields_set:
81
+ _dict['clientSecret'] = None
82
+
83
+ # set to None if flow_service_url (nullable) is None
84
+ # and model_fields_set contains the field
85
+ if self.flow_service_url is None and "flow_service_url" in self.model_fields_set:
86
+ _dict['flowServiceUrl'] = None
87
+
88
+ return _dict
89
+
90
+ @classmethod
91
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
92
+ """Create an instance of AFNORCredentials from a dict"""
93
+ if obj is None:
94
+ return None
95
+
96
+ if not isinstance(obj, dict):
97
+ return cls.model_validate(obj)
98
+
99
+ _obj = cls.model_validate({
100
+ "clientId": obj.get("clientId"),
101
+ "clientSecret": obj.get("clientSecret"),
102
+ "flowServiceUrl": obj.get("flowServiceUrl")
103
+ })
104
+ return _obj
105
+
106
+