factpulse 4.0.3 → 4.1.2

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 (415) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -4
  3. data/Gemfile.lock +2 -2
  4. data/docs/AFNORErrorDetail.md +26 -0
  5. data/docs/AsyncTasksApi.md +225 -0
  6. data/docs/ClientManagementApi.md +20 -20
  7. data/docs/ConversionErrorResult.md +30 -0
  8. data/docs/ConversionExtractionInfo.md +20 -0
  9. data/docs/ConversionPendingInputResult.md +30 -0
  10. data/docs/ConversionSuccessTaskResult.md +36 -0
  11. data/docs/ConversionTaskStatus.md +22 -0
  12. data/docs/ConversionTaskStatusResult.md +85 -0
  13. data/docs/ConversionValidationFailedResult.md +34 -0
  14. data/docs/DownloadsApi.md +4 -4
  15. data/docs/FacturXConversionApi.md +75 -0
  16. data/docs/FacturXInvoice.md +1 -1
  17. data/docs/FacturXPDFXMLVerificationApi.md +75 -0
  18. data/docs/FacturXValidationApi.md +0 -81
  19. data/docs/FactureElectroniqueModelsInvoiceTypeCode.md +15 -0
  20. data/docs/Flux6InvoiceLifecycleCDARApi.md +82 -0
  21. data/docs/GenerationSuccessResult.md +24 -0
  22. data/docs/GenerationTaskStatus.md +22 -0
  23. data/docs/GenerationTaskStatusResult.md +79 -0
  24. data/docs/HealthApi.md +0 -124
  25. data/docs/{FacturXGenerationApi.md → InvoiceGenerationApi.md} +21 -21
  26. data/docs/InvoiceInput.md +1 -1
  27. data/docs/InvoiceLifecycle.md +24 -0
  28. data/docs/InvoicingFramework.md +1 -1
  29. data/docs/LifecycleEvent.md +38 -0
  30. data/docs/LifecycleResponse.md +22 -0
  31. data/docs/ParseApi.md +161 -0
  32. data/docs/ParseFacturXResponse.md +26 -0
  33. data/docs/ReferencesApi.md +74 -0
  34. data/docs/SignatureSuccessResult.md +34 -0
  35. data/docs/SignatureTaskStatus.md +22 -0
  36. data/docs/SignatureTaskStatusResult.md +79 -0
  37. data/docs/SimplifiedInvoiceData.md +1 -1
  38. data/docs/SubmitCompleteInvoiceResponse.md +3 -1
  39. data/docs/Supplier.md +1 -1
  40. data/docs/TaskErrorResult.md +26 -0
  41. data/docs/VATEXCodeInfo.md +24 -0
  42. data/docs/VATEXCodesResponse.md +22 -0
  43. data/docs/ValidationApi.md +88 -0
  44. data/docs/ValidationSuccessTaskResult.md +20 -0
  45. data/docs/ValidationTaskStatus.md +22 -0
  46. data/docs/ValidationTaskStatusResult.md +79 -0
  47. data/docs/VerificationSuccessTaskResult.md +20 -0
  48. data/docs/VerificationTypedTaskStatus.md +22 -0
  49. data/docs/VerificationTypedTaskStatusResult.md +79 -0
  50. data/factpulse.gemspec +3 -3
  51. data/lib/factpulse/api/afnorpdppa_api.rb +2 -2
  52. data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +2 -2
  53. data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +2 -2
  54. data/lib/factpulse/api/async_tasks_api.rb +191 -2
  55. data/lib/factpulse/api/chorus_pro_api.rb +2 -2
  56. data/lib/factpulse/api/client_management_api.rb +22 -22
  57. data/lib/factpulse/api/downloads_api.rb +6 -6
  58. data/lib/factpulse/api/electronic_signature_api.rb +2 -2
  59. data/lib/factpulse/api/factur_x_conversion_api.rb +65 -2
  60. data/lib/factpulse/api/factur_x_validation_api.rb +2 -77
  61. data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +65 -2
  62. data/lib/factpulse/api/flux10_e_reporting_api.rb +2 -2
  63. data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +85 -2
  64. data/lib/factpulse/api/health_api.rb +2 -116
  65. data/lib/factpulse/api/{factur_x_generation_api.rb → invoice_generation_api.rb} +23 -23
  66. data/lib/factpulse/api/parse_api.rb +163 -0
  67. data/lib/factpulse/api/references_api.rb +82 -0
  68. data/lib/factpulse/api/validation_api.rb +97 -0
  69. data/lib/factpulse/api_client.rb +2 -2
  70. data/lib/factpulse/api_error.rb +2 -2
  71. data/lib/factpulse/api_model_base.rb +2 -2
  72. data/lib/factpulse/configuration.rb +2 -2
  73. data/lib/factpulse/models/acknowledgment_status.rb +2 -2
  74. data/lib/factpulse/models/action_code_info.rb +2 -2
  75. data/lib/factpulse/models/action_codes_response.rb +2 -2
  76. data/lib/factpulse/models/additional_document.rb +2 -2
  77. data/lib/factpulse/models/afnor_acknowledgement.rb +2 -2
  78. data/lib/factpulse/models/afnor_acknowledgement_detail.rb +2 -2
  79. data/lib/factpulse/models/afnor_address_edit.rb +2 -2
  80. data/lib/factpulse/models/afnor_address_patch.rb +2 -2
  81. data/lib/factpulse/models/afnor_address_put.rb +2 -2
  82. data/lib/factpulse/models/afnor_address_read.rb +2 -2
  83. data/lib/factpulse/models/afnor_algorithm.rb +2 -2
  84. data/lib/factpulse/models/afnor_contains_operator.rb +2 -2
  85. data/lib/factpulse/models/afnor_create_directory_line_body.rb +2 -2
  86. data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +2 -2
  87. data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +2 -2
  88. data/lib/factpulse/models/afnor_create_routing_code_body.rb +2 -2
  89. data/lib/factpulse/models/afnor_credentials.rb +2 -2
  90. data/lib/factpulse/models/afnor_destination.rb +2 -2
  91. data/lib/factpulse/models/afnor_diffusion_status.rb +2 -2
  92. data/lib/factpulse/models/afnor_directory_line_field.rb +2 -2
  93. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb +2 -2
  94. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb +2 -2
  95. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +2 -2
  96. data/lib/factpulse/models/afnor_directory_line_post201_response.rb +2 -2
  97. data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +2 -2
  98. data/lib/factpulse/models/afnor_entity_type.rb +2 -2
  99. data/lib/factpulse/models/afnor_error.rb +2 -2
  100. data/lib/factpulse/models/afnor_error_detail.rb +237 -0
  101. data/lib/factpulse/models/afnor_facility_administrative_status.rb +2 -2
  102. data/lib/factpulse/models/afnor_facility_nature.rb +2 -2
  103. data/lib/factpulse/models/afnor_facility_payload_history.rb +2 -2
  104. data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +2 -2
  105. data/lib/factpulse/models/afnor_facility_payload_included.rb +2 -2
  106. data/lib/factpulse/models/afnor_facility_type.rb +2 -2
  107. data/lib/factpulse/models/afnor_flow.rb +2 -2
  108. data/lib/factpulse/models/afnor_flow_ack_status.rb +2 -2
  109. data/lib/factpulse/models/afnor_flow_direction.rb +2 -2
  110. data/lib/factpulse/models/afnor_flow_info.rb +2 -2
  111. data/lib/factpulse/models/afnor_flow_profile.rb +2 -2
  112. data/lib/factpulse/models/afnor_flow_syntax.rb +2 -2
  113. data/lib/factpulse/models/afnor_flow_type.rb +2 -2
  114. data/lib/factpulse/models/afnor_full_flow_info.rb +2 -2
  115. data/lib/factpulse/models/afnor_health_check_response.rb +2 -2
  116. data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +2 -2
  117. data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +2 -2
  118. data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +2 -2
  119. data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +2 -2
  120. data/lib/factpulse/models/afnor_platform_status.rb +2 -2
  121. data/lib/factpulse/models/afnor_processing_rule.rb +2 -2
  122. data/lib/factpulse/models/afnor_reason_code.rb +2 -2
  123. data/lib/factpulse/models/afnor_reason_code_enum.rb +2 -2
  124. data/lib/factpulse/models/afnor_recipient_platform_type.rb +2 -2
  125. data/lib/factpulse/models/afnor_result.rb +2 -2
  126. data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +2 -2
  127. data/lib/factpulse/models/afnor_routing_code_field.rb +2 -2
  128. data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +2 -2
  129. data/lib/factpulse/models/afnor_routing_code_post201_response.rb +2 -2
  130. data/lib/factpulse/models/afnor_routing_code_search.rb +2 -2
  131. data/lib/factpulse/models/afnor_routing_code_search_filters.rb +2 -2
  132. data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +2 -2
  133. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +2 -2
  134. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +2 -2
  135. data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +2 -2
  136. data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +2 -2
  137. data/lib/factpulse/models/afnor_search_directory_line.rb +2 -2
  138. data/lib/factpulse/models/afnor_search_directory_line_filters.rb +2 -2
  139. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +2 -2
  140. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +2 -2
  141. data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +2 -2
  142. data/lib/factpulse/models/afnor_search_flow_content.rb +2 -2
  143. data/lib/factpulse/models/afnor_search_flow_filters.rb +2 -2
  144. data/lib/factpulse/models/afnor_search_flow_params.rb +2 -2
  145. data/lib/factpulse/models/afnor_search_siren.rb +2 -2
  146. data/lib/factpulse/models/afnor_search_siren_filters.rb +2 -2
  147. data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +2 -2
  148. data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +2 -2
  149. data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +2 -2
  150. data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +2 -2
  151. data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +2 -2
  152. data/lib/factpulse/models/afnor_search_siret.rb +2 -2
  153. data/lib/factpulse/models/afnor_search_siret_filters.rb +2 -2
  154. data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +2 -2
  155. data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +2 -2
  156. data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +2 -2
  157. data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +2 -2
  158. data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +2 -2
  159. data/lib/factpulse/models/afnor_search_siret_filters_name.rb +2 -2
  160. data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +2 -2
  161. data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +2 -2
  162. data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +2 -2
  163. data/lib/factpulse/models/afnor_siren_field.rb +2 -2
  164. data/lib/factpulse/models/afnor_siren_search_post200_response.rb +2 -2
  165. data/lib/factpulse/models/afnor_siret_field.rb +2 -2
  166. data/lib/factpulse/models/afnor_siret_search_post200_response.rb +2 -2
  167. data/lib/factpulse/models/afnor_sorting_order.rb +2 -2
  168. data/lib/factpulse/models/afnor_strict_operator.rb +2 -2
  169. data/lib/factpulse/models/afnor_update_patch_directory_line_body.rb +2 -2
  170. data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +2 -2
  171. data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +2 -2
  172. data/lib/factpulse/models/afnor_webhook_callback_content.rb +2 -2
  173. data/lib/factpulse/models/aggregated_payment_input.rb +2 -2
  174. data/lib/factpulse/models/aggregated_transaction_input.rb +2 -2
  175. data/lib/factpulse/models/allowance_charge.rb +2 -2
  176. data/lib/factpulse/models/allowance_charge_reason_code.rb +2 -2
  177. data/lib/factpulse/models/allowance_reason_code.rb +2 -2
  178. data/lib/factpulse/models/allowance_total_amount.rb +2 -2
  179. data/lib/factpulse/models/amount.rb +2 -2
  180. data/lib/factpulse/models/amount1.rb +2 -2
  181. data/lib/factpulse/models/amount2.rb +2 -2
  182. data/lib/factpulse/models/amount_due.rb +2 -2
  183. data/lib/factpulse/models/api_error.rb +2 -2
  184. data/lib/factpulse/models/api_profile.rb +2 -2
  185. data/lib/factpulse/models/async_task_status.rb +2 -2
  186. data/lib/factpulse/models/base_amount.rb +2 -2
  187. data/lib/factpulse/models/bounding_box_schema.rb +2 -2
  188. data/lib/factpulse/models/buyercountry.rb +2 -2
  189. data/lib/factpulse/models/celery_status.rb +2 -2
  190. data/lib/factpulse/models/certificate_info_response.rb +2 -2
  191. data/lib/factpulse/models/charge_total_amount.rb +2 -2
  192. data/lib/factpulse/models/chorus_pro_credentials.rb +2 -2
  193. data/lib/factpulse/models/chorus_pro_destination.rb +2 -2
  194. data/lib/factpulse/models/chorus_pro_result.rb +2 -2
  195. data/lib/factpulse/models/client_activate_response.rb +2 -2
  196. data/lib/factpulse/models/client_create_request.rb +2 -2
  197. data/lib/factpulse/models/client_detail.rb +2 -2
  198. data/lib/factpulse/models/client_list_response.rb +2 -2
  199. data/lib/factpulse/models/client_summary.rb +2 -2
  200. data/lib/factpulse/models/client_update_request.rb +2 -2
  201. data/lib/factpulse/models/contact.rb +2 -2
  202. data/lib/factpulse/models/conversion_error_result.rb +277 -0
  203. data/lib/factpulse/models/conversion_extraction_info.rb +176 -0
  204. data/lib/factpulse/models/conversion_pending_input_result.rb +344 -0
  205. data/lib/factpulse/models/conversion_success_task_result.rb +355 -0
  206. data/lib/factpulse/models/conversion_task_status.rb +223 -0
  207. data/lib/factpulse/models/conversion_task_status_result.rb +59 -0
  208. data/lib/factpulse/models/conversion_validation_failed_result.rb +348 -0
  209. data/lib/factpulse/models/convert_resume_request.rb +2 -2
  210. data/lib/factpulse/models/convert_success_response.rb +2 -2
  211. data/lib/factpulse/models/convert_validation_failed_response.rb +2 -2
  212. data/lib/factpulse/models/country_code.rb +2 -2
  213. data/lib/factpulse/models/create_aggregated_report_request.rb +2 -2
  214. data/lib/factpulse/models/create_cdar_request.rb +2 -2
  215. data/lib/factpulse/models/create_e_reporting_request.rb +2 -2
  216. data/lib/factpulse/models/currency.rb +2 -2
  217. data/lib/factpulse/models/currency_code.rb +2 -2
  218. data/lib/factpulse/models/delivery_party.rb +2 -2
  219. data/lib/factpulse/models/destination.rb +2 -2
  220. data/lib/factpulse/models/doc_type.rb +2 -2
  221. data/lib/factpulse/models/document_type_info.rb +2 -2
  222. data/lib/factpulse/models/e_reporting_flow_type.rb +2 -2
  223. data/lib/factpulse/models/e_reporting_validation_error.rb +2 -2
  224. data/lib/factpulse/models/electronic_address.rb +2 -2
  225. data/lib/factpulse/models/encaisseamount.rb +2 -2
  226. data/lib/factpulse/models/encaisseamount1.rb +2 -2
  227. data/lib/factpulse/models/encaissee_request.rb +2 -2
  228. data/lib/factpulse/models/enriched_invoice_info.rb +2 -2
  229. data/lib/factpulse/models/error_level.rb +2 -2
  230. data/lib/factpulse/models/error_source.rb +2 -2
  231. data/lib/factpulse/models/extraction_info.rb +2 -2
  232. data/lib/factpulse/models/factur_x_invoice.rb +3 -19
  233. data/lib/factpulse/models/factur_xpdf_info.rb +2 -2
  234. data/lib/factpulse/models/facture_electronique_models_invoice_type_code.rb +54 -0
  235. data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +2 -2
  236. data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +2 -2
  237. data/lib/factpulse/models/field_status.rb +2 -2
  238. data/lib/factpulse/models/file_info.rb +2 -2
  239. data/lib/factpulse/models/files_info.rb +2 -2
  240. data/lib/factpulse/models/flow_direction.rb +2 -2
  241. data/lib/factpulse/models/flow_profile.rb +2 -2
  242. data/lib/factpulse/models/flow_summary.rb +2 -2
  243. data/lib/factpulse/models/flow_syntax.rb +2 -2
  244. data/lib/factpulse/models/flow_type.rb +2 -2
  245. data/lib/factpulse/models/generate_aggregated_report_response.rb +2 -2
  246. data/lib/factpulse/models/generate_cdar_response.rb +2 -2
  247. data/lib/factpulse/models/generate_certificate_request.rb +2 -2
  248. data/lib/factpulse/models/generate_certificate_response.rb +2 -2
  249. data/lib/factpulse/models/generate_e_reporting_response.rb +2 -2
  250. data/lib/factpulse/models/generation_success_result.rb +230 -0
  251. data/lib/factpulse/models/generation_task_status.rb +223 -0
  252. data/lib/factpulse/models/generation_task_status_result.rb +55 -0
  253. data/lib/factpulse/models/get_chorus_pro_id_request.rb +2 -2
  254. data/lib/factpulse/models/get_chorus_pro_id_response.rb +2 -2
  255. data/lib/factpulse/models/get_invoice_request.rb +2 -2
  256. data/lib/factpulse/models/get_invoice_response.rb +2 -2
  257. data/lib/factpulse/models/get_structure_request.rb +2 -2
  258. data/lib/factpulse/models/get_structure_response.rb +2 -2
  259. data/lib/factpulse/models/global_allowance_amount.rb +2 -2
  260. data/lib/factpulse/models/gross_unit_price.rb +2 -2
  261. data/lib/factpulse/models/http_validation_error.rb +2 -2
  262. data/lib/factpulse/models/incoming_invoice.rb +2 -2
  263. data/lib/factpulse/models/incoming_supplier.rb +2 -2
  264. data/lib/factpulse/models/invoice_format.rb +2 -2
  265. data/lib/factpulse/models/invoice_input.rb +3 -3
  266. data/lib/factpulse/models/invoice_lifecycle.rb +215 -0
  267. data/lib/factpulse/models/invoice_line.rb +2 -2
  268. data/lib/factpulse/models/invoice_line_allowance_amount.rb +2 -2
  269. data/lib/factpulse/models/invoice_note.rb +2 -2
  270. data/lib/factpulse/models/invoice_payment_input.rb +2 -2
  271. data/lib/factpulse/models/invoice_references.rb +2 -2
  272. data/lib/factpulse/models/invoice_status.rb +2 -2
  273. data/lib/factpulse/models/invoice_totals.rb +2 -2
  274. data/lib/factpulse/models/invoice_totals_prepayment.rb +2 -2
  275. data/lib/factpulse/models/invoice_type_code.rb +8 -19
  276. data/lib/factpulse/models/invoice_type_code_output.rb +2 -2
  277. data/lib/factpulse/models/invoicing_framework.rb +3 -20
  278. data/lib/factpulse/models/invoicing_framework_code.rb +2 -2
  279. data/lib/factpulse/models/issuer_role_code.rb +2 -2
  280. data/lib/factpulse/models/key_rotation_request.rb +2 -2
  281. data/lib/factpulse/models/key_rotation_response.rb +2 -2
  282. data/lib/factpulse/models/lifecycle_event.rb +300 -0
  283. data/lib/factpulse/models/lifecycle_response.rb +205 -0
  284. data/lib/factpulse/models/line_net_amount.rb +2 -2
  285. data/lib/factpulse/models/line_sub_type.rb +2 -2
  286. data/lib/factpulse/models/line_total_amount.rb +2 -2
  287. data/lib/factpulse/models/location_inner.rb +2 -2
  288. data/lib/factpulse/models/mandatory_note_schema.rb +2 -2
  289. data/lib/factpulse/models/manual_rate.rb +2 -2
  290. data/lib/factpulse/models/manual_vat_rate.rb +2 -2
  291. data/lib/factpulse/models/missing_field.rb +2 -2
  292. data/lib/factpulse/models/operation_nature.rb +2 -2
  293. data/lib/factpulse/models/output_format.rb +5 -3
  294. data/lib/factpulse/models/page_dimensions_schema.rb +2 -2
  295. data/lib/factpulse/models/parse_factur_x_response.rb +249 -0
  296. data/lib/factpulse/models/payee.rb +2 -2
  297. data/lib/factpulse/models/payment_amount_by_rate.rb +2 -2
  298. data/lib/factpulse/models/payment_card.rb +2 -2
  299. data/lib/factpulse/models/payment_means.rb +2 -2
  300. data/lib/factpulse/models/pdf_validation_result_api.rb +2 -2
  301. data/lib/factpulse/models/pdp_config_response.rb +2 -2
  302. data/lib/factpulse/models/pdp_config_update_request.rb +2 -2
  303. data/lib/factpulse/models/pdp_credentials.rb +2 -2
  304. data/lib/factpulse/models/percentage.rb +2 -2
  305. data/lib/factpulse/models/postal_address.rb +2 -2
  306. data/lib/factpulse/models/price_allowance_amount.rb +2 -2
  307. data/lib/factpulse/models/price_basis_quantity.rb +2 -2
  308. data/lib/factpulse/models/processing_options.rb +2 -2
  309. data/lib/factpulse/models/processing_rule.rb +2 -2
  310. data/lib/factpulse/models/product_characteristic.rb +2 -2
  311. data/lib/factpulse/models/product_classification.rb +2 -2
  312. data/lib/factpulse/models/quantity.rb +2 -2
  313. data/lib/factpulse/models/rate.rb +2 -2
  314. data/lib/factpulse/models/rate1.rb +2 -2
  315. data/lib/factpulse/models/reason_code_info.rb +2 -2
  316. data/lib/factpulse/models/reason_codes_response.rb +2 -2
  317. data/lib/factpulse/models/recipient.rb +2 -2
  318. data/lib/factpulse/models/recipient_input.rb +2 -2
  319. data/lib/factpulse/models/refusee_request.rb +2 -2
  320. data/lib/factpulse/models/report_issuer.rb +2 -2
  321. data/lib/factpulse/models/report_period.rb +2 -2
  322. data/lib/factpulse/models/report_sender.rb +2 -2
  323. data/lib/factpulse/models/rounding_amount.rb +2 -2
  324. data/lib/factpulse/models/schematron_validation_error.rb +2 -2
  325. data/lib/factpulse/models/scheme_id.rb +2 -2
  326. data/lib/factpulse/models/search_flow_request.rb +2 -2
  327. data/lib/factpulse/models/search_flow_response.rb +2 -2
  328. data/lib/factpulse/models/search_services_response.rb +2 -2
  329. data/lib/factpulse/models/search_structure_request.rb +2 -2
  330. data/lib/factpulse/models/search_structure_response.rb +2 -2
  331. data/lib/factpulse/models/secret_status.rb +2 -2
  332. data/lib/factpulse/models/sellercountry.rb +2 -2
  333. data/lib/factpulse/models/signature_info.rb +2 -2
  334. data/lib/factpulse/models/signature_info_api.rb +2 -2
  335. data/lib/factpulse/models/signature_parameters.rb +2 -2
  336. data/lib/factpulse/models/signature_success_result.rb +394 -0
  337. data/lib/factpulse/models/signature_task_status.rb +223 -0
  338. data/lib/factpulse/models/signature_task_status_result.rb +55 -0
  339. data/lib/factpulse/models/simplified_cdar_response.rb +2 -2
  340. data/lib/factpulse/models/simplified_invoice_data.rb +3 -3
  341. data/lib/factpulse/models/status_code_info.rb +2 -2
  342. data/lib/factpulse/models/status_codes_response.rb +2 -2
  343. data/lib/factpulse/models/structure_info.rb +2 -2
  344. data/lib/factpulse/models/structure_parameters.rb +2 -2
  345. data/lib/factpulse/models/structure_service.rb +2 -2
  346. data/lib/factpulse/models/submission_mode.rb +2 -2
  347. data/lib/factpulse/models/submit_aggregated_report_request.rb +2 -2
  348. data/lib/factpulse/models/submit_cdar_request.rb +2 -2
  349. data/lib/factpulse/models/submit_cdar_response.rb +2 -2
  350. data/lib/factpulse/models/submit_cdarxml_request.rb +2 -2
  351. data/lib/factpulse/models/submit_complete_invoice_request.rb +2 -2
  352. data/lib/factpulse/models/submit_complete_invoice_response.rb +33 -4
  353. data/lib/factpulse/models/submit_e_reporting_request.rb +2 -2
  354. data/lib/factpulse/models/submit_e_reporting_response.rb +2 -2
  355. data/lib/factpulse/models/submit_flow_request.rb +2 -2
  356. data/lib/factpulse/models/submit_flow_response.rb +2 -2
  357. data/lib/factpulse/models/submit_gross_amount.rb +2 -2
  358. data/lib/factpulse/models/submit_invoice_request.rb +2 -2
  359. data/lib/factpulse/models/submit_invoice_response.rb +2 -2
  360. data/lib/factpulse/models/submit_net_amount.rb +2 -2
  361. data/lib/factpulse/models/submit_vat_amount.rb +2 -2
  362. data/lib/factpulse/models/supplementary_attachment.rb +2 -2
  363. data/lib/factpulse/models/supplier.rb +4 -18
  364. data/lib/factpulse/models/task_error_result.rb +257 -0
  365. data/lib/factpulse/models/task_response.rb +2 -2
  366. data/lib/factpulse/models/tax_breakdown_input.rb +2 -2
  367. data/lib/factpulse/models/tax_due_date_type.rb +2 -2
  368. data/lib/factpulse/models/tax_representative.rb +2 -2
  369. data/lib/factpulse/models/taxable_amount.rb +2 -2
  370. data/lib/factpulse/models/taxableamount.rb +2 -2
  371. data/lib/factpulse/models/taxamount.rb +2 -2
  372. data/lib/factpulse/models/taxamount1.rb +2 -2
  373. data/lib/factpulse/models/taxamount2.rb +2 -2
  374. data/lib/factpulse/models/taxexclusiveamount.rb +2 -2
  375. data/lib/factpulse/models/taxexclusiveamount1.rb +2 -2
  376. data/lib/factpulse/models/total_gross_amount.rb +2 -2
  377. data/lib/factpulse/models/total_net_amount.rb +2 -2
  378. data/lib/factpulse/models/total_vat_amount.rb +2 -2
  379. data/lib/factpulse/models/transaction_category.rb +2 -2
  380. data/lib/factpulse/models/transmission_type_code.rb +2 -2
  381. data/lib/factpulse/models/unit_net_price.rb +2 -2
  382. data/lib/factpulse/models/unit_of_measure.rb +17 -3
  383. data/lib/factpulse/models/validate_cdar_request.rb +2 -2
  384. data/lib/factpulse/models/validate_cdar_response.rb +2 -2
  385. data/lib/factpulse/models/validate_e_reporting_request.rb +2 -2
  386. data/lib/factpulse/models/validate_e_reporting_response.rb +2 -2
  387. data/lib/factpulse/models/validation_error.rb +2 -2
  388. data/lib/factpulse/models/validation_error_detail.rb +2 -2
  389. data/lib/factpulse/models/validation_error_response.rb +2 -2
  390. data/lib/factpulse/models/validation_info.rb +2 -2
  391. data/lib/factpulse/models/validation_success_response.rb +2 -2
  392. data/lib/factpulse/models/validation_success_task_result.rb +210 -0
  393. data/lib/factpulse/models/validation_task_status.rb +223 -0
  394. data/lib/factpulse/models/validation_task_status_result.rb +55 -0
  395. data/lib/factpulse/models/vat_accounting_code.rb +2 -2
  396. data/lib/factpulse/models/vat_amount.rb +2 -2
  397. data/lib/factpulse/models/vat_category.rb +2 -2
  398. data/lib/factpulse/models/vat_line.rb +2 -2
  399. data/lib/factpulse/models/vat_point_date_code.rb +2 -2
  400. data/lib/factpulse/models/vat_rate.rb +2 -2
  401. data/lib/factpulse/models/vatex_code_info.rb +247 -0
  402. data/lib/factpulse/models/vatex_codes_response.rb +204 -0
  403. data/lib/factpulse/models/verification_success_response.rb +2 -2
  404. data/lib/factpulse/models/verification_success_task_result.rb +210 -0
  405. data/lib/factpulse/models/verification_typed_task_status.rb +223 -0
  406. data/lib/factpulse/models/verification_typed_task_status_result.rb +55 -0
  407. data/lib/factpulse/models/verified_field_schema.rb +2 -2
  408. data/lib/factpulse/models/webhook_secret_delete_response.rb +2 -2
  409. data/lib/factpulse/models/webhook_secret_generate_response.rb +2 -2
  410. data/lib/factpulse/models/webhook_secret_status_response.rb +2 -2
  411. data/lib/factpulse/version.rb +3 -3
  412. data/lib/factpulse.rb +34 -4
  413. metadata +121 -61
  414. data/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +0 -15
  415. data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +0 -43
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - 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) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 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/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -21,7 +21,7 @@ module FactPulse
21
21
  end
22
22
  # Check if a file exists
23
23
  # Check if a temporary file exists and get its metadata without downloading. Useful for: - Verifying a download URL is still valid - Getting file size before downloading - Checking expiration time **Security**: Requires authentication, only file owner can check.
24
- # @param download_id [String]
24
+ # @param download_id [String] Unique identifier of the temporary file to check
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [Object]
27
27
  def check_file_api_v1_download_download_id_head(download_id, opts = {})
@@ -31,7 +31,7 @@ module FactPulse
31
31
 
32
32
  # Check if a file exists
33
33
  # Check if a temporary file exists and get its metadata without downloading. Useful for: - Verifying a download URL is still valid - Getting file size before downloading - Checking expiration time **Security**: Requires authentication, only file owner can check.
34
- # @param download_id [String]
34
+ # @param download_id [String] Unique identifier of the temporary file to check
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
37
37
  def check_file_api_v1_download_download_id_head_with_http_info(download_id, opts = {})
@@ -84,7 +84,7 @@ module FactPulse
84
84
 
85
85
  # Download a temporary file
86
86
  # Download a file stored temporarily after asynchronous processing. **Usage**: - This URL is provided in webhook notifications when using `webhook_mode: \"download_url\"` - Files are automatically deleted after 1 hour - Each file can only be downloaded until it expires **Security**: - Requires a valid JWT token - Only the user who initiated the task can download the file
87
- # @param download_id [String]
87
+ # @param download_id [String] Unique identifier of the temporary file to download
88
88
  # @param [Hash] opts the optional parameters
89
89
  # @option opts [Boolean] :delete_after If true, delete the file after download (one-time download) (default to false)
90
90
  # @return [Object]
@@ -95,7 +95,7 @@ module FactPulse
95
95
 
96
96
  # Download a temporary file
97
97
  # Download a file stored temporarily after asynchronous processing. **Usage**: - This URL is provided in webhook notifications when using &#x60;webhook_mode: \&quot;download_url\&quot;&#x60; - Files are automatically deleted after 1 hour - Each file can only be downloaded until it expires **Security**: - Requires a valid JWT token - Only the user who initiated the task can download the file
98
- # @param download_id [String]
98
+ # @param download_id [String] Unique identifier of the temporary file to download
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @option opts [Boolean] :delete_after If true, delete the file after download (one-time download) (default to false)
101
101
  # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - 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) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 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/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - 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) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 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/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -229,6 +229,69 @@ module FactPulse
229
229
  return data, status_code, headers
230
230
  end
231
231
 
232
+ # Get typed conversion task status
233
+ # Typed status endpoint for document conversion tasks. Returns a strongly-typed `result` discriminated on `result.status`: - **SUCCESS**: `ConversionSuccessTaskResult` - **PENDING_INPUT**: `ConversionPendingInputResult` (missing fields) - **VALIDATION_FAILED**: `ConversionValidationFailedResult` - **ERROR**: `ConversionErrorResult`
234
+ # @param task_id [String] Celery task ID returned by POST /convert
235
+ # @param [Hash] opts the optional parameters
236
+ # @return [ConversionTaskStatus]
237
+ def get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get(task_id, opts = {})
238
+ data, _status_code, _headers = get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info(task_id, opts)
239
+ data
240
+ end
241
+
242
+ # Get typed conversion task status
243
+ # Typed status endpoint for document conversion tasks. Returns a strongly-typed &#x60;result&#x60; discriminated on &#x60;result.status&#x60;: - **SUCCESS**: &#x60;ConversionSuccessTaskResult&#x60; - **PENDING_INPUT**: &#x60;ConversionPendingInputResult&#x60; (missing fields) - **VALIDATION_FAILED**: &#x60;ConversionValidationFailedResult&#x60; - **ERROR**: &#x60;ConversionErrorResult&#x60;
244
+ # @param task_id [String] Celery task ID returned by POST /convert
245
+ # @param [Hash] opts the optional parameters
246
+ # @return [Array<(ConversionTaskStatus, Integer, Hash)>] ConversionTaskStatus data, response status code and response headers
247
+ def get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get_with_http_info(task_id, opts = {})
248
+ if @api_client.config.debugging
249
+ @api_client.config.logger.debug 'Calling API: FacturXConversionApi.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get ...'
250
+ end
251
+ # verify the required parameter 'task_id' is set
252
+ if @api_client.config.client_side_validation && task_id.nil?
253
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling FacturXConversionApi.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get"
254
+ end
255
+ # resource path
256
+ local_var_path = '/api/v1/convert/tasks/{task_id}/conversion-status'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
257
+
258
+ # query parameters
259
+ query_params = opts[:query_params] || {}
260
+
261
+ # header parameters
262
+ header_params = opts[:header_params] || {}
263
+ # HTTP header 'Accept' (if needed)
264
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
265
+
266
+ # form parameters
267
+ form_params = opts[:form_params] || {}
268
+
269
+ # http body (model)
270
+ post_body = opts[:debug_body]
271
+
272
+ # return_type
273
+ return_type = opts[:debug_return_type] || 'ConversionTaskStatus'
274
+
275
+ # auth_names
276
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
277
+
278
+ new_options = opts.merge(
279
+ :operation => :"FacturXConversionApi.get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get",
280
+ :header_params => header_params,
281
+ :query_params => query_params,
282
+ :form_params => form_params,
283
+ :body => post_body,
284
+ :auth_names => auth_names,
285
+ :return_type => return_type
286
+ )
287
+
288
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
289
+ if @api_client.config.debugging
290
+ @api_client.config.logger.debug "API called: FacturXConversionApi#get_conversion_task_status_api_v1_convert_tasks_task_id_conversion_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
291
+ end
292
+ return data, status_code, headers
293
+ end
294
+
232
295
  # Resume a conversion with corrections
233
296
  # Resume a conversion after completing missing data or correcting errors. The OCR extraction is preserved, data is updated with corrections, then a new Schematron validation is performed.
234
297
  # @param conversion_id [String] Conversion ID returned by POST /convert (UUID format)
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - 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) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 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/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -177,80 +177,5 @@ module FactPulse
177
177
  end
178
178
  return data, status_code, headers
179
179
  end
180
-
181
- # Validate an existing Factur-X XML
182
- # Validates a Factur-X XML file against Schematron business rules according to EN 16931 standard. ## Applied Standard **Schematron ISO/IEC 19757-3**: Business rules validation language for XML - Semantic validation (beyond XSD syntax) - European EN 16931 business rules - French-specific Factur-X rules - Arithmetic calculations and data consistency ## Profiles and validated rules ### MINIMUM (45 rules) - Unique invoice identifier - Dates (issue, due date) - Party identifiers (SIRET/SIREN) - Total gross amount ### BASIC (102 rules) - All MINIMUM rules - Detailed invoice lines - Basic VAT calculations - Payment methods - References (order, contract) ### EN16931 (178 rules) - All BASIC rules - **European rules (BR-xx)**: 81 business rules - **French rules (FR-xx)**: 12 France-specific rules - **Advanced calculations (CR-xx)**: 32 calculation rules - **Standardized codes (CL-xx)**: 52 code lists ### EXTENDED (210+ rules) - All EN16931 rules - Logistics information - Advanced accounting data - Multiple external references ## Checks performed ### 1. Syntax validation - Correct XML parsing (UTF-8, well-formed) - UN/CEFACT namespaces present - Hierarchical structure respected ### 2. Business rules (BR-xx) Examples: - `BR-1`: Invoice total must equal sum of line totals + document-level amounts - `BR-CO-10`: Sum of VAT base amounts must equal invoice net total - `BR-16`: Invoice currency code must be in ISO 4217 list ### 3. French rules (FR-xx) Examples: - `FR-1`: Supplier SIRET must have 14 digits - `FR-2`: Customer SIRET must have 14 digits (if present) - `FR-5`: Intra-EU VAT number must be in format FRxx999999999 ### 4. Calculation rules (CR-xx) - Net + VAT = Gross amounts - Sum of lines = Document total - Discounts and surcharges correctly applied - Compliant rounding (2 decimals for amounts) ### 5. Standardized codes (CL-xx) - ISO 3166-1 alpha-2 country codes - ISO 4217 currency codes - UN/ECE Rec 20 measurement units - VAT codes (types, categories, exemptions) - SchemeID for identifiers (0002=SIREN, 0009=SIRET, etc.) ## Validation process 1. **XSLT loading**: Schematron file converted to XSLT (Saxon-HE) 2. **Transformation**: Rules applied to XML 3. **Results analysis**: Extraction of errors (`failed-assert`) and warnings (`successful-report`) 4. **Report**: Structured list of non-conformities ## Responses **200 OK**: Compliant XML ```json { \"message\": \"XML is compliant with EN16931 profile\" } ``` **400 Bad Request**: Non-compliant XML ```json { \"detail\": [ \"[BR-1] Invoice total (120.00) does not match calculated sum (100.00 + 20.00)\", \"[FR-1] Supplier SIRET must contain exactly 14 digits\" ] } ``` ## Use cases - **Pre-validation**: Verify XML before PDF/A integration - **Debugging**: Precisely identify generation errors - **Testing**: Validate test or example XMLs - **Compliance**: Ensure European and French rules are met - **Development**: Quick testing without PDF generation ## Processing time - MINIMUM profile: ~0.5 second - EN16931 profile: ~1-2 seconds - EXTENDED profile: ~2-3 seconds
183
- # @param xml_file [File] Factur-X XML file to validate (.xml format).
184
- # @param [Hash] opts the optional parameters
185
- # @option opts [APIProfile] :profile Validation profile (MINIMUM, BASIC, EN16931, EXTENDED).
186
- # @option opts [Boolean] :skip_br_fr
187
- # @return [ValidationSuccessResponse]
188
- def validate_xml_api_v1_processing_validate_xml_post(xml_file, opts = {})
189
- data, _status_code, _headers = validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts)
190
- data
191
- end
192
-
193
- # Validate an existing Factur-X XML
194
- # Validates a Factur-X XML file against Schematron business rules according to EN 16931 standard. ## Applied Standard **Schematron ISO/IEC 19757-3**: Business rules validation language for XML - Semantic validation (beyond XSD syntax) - European EN 16931 business rules - French-specific Factur-X rules - Arithmetic calculations and data consistency ## Profiles and validated rules ### MINIMUM (45 rules) - Unique invoice identifier - Dates (issue, due date) - Party identifiers (SIRET/SIREN) - Total gross amount ### BASIC (102 rules) - All MINIMUM rules - Detailed invoice lines - Basic VAT calculations - Payment methods - References (order, contract) ### EN16931 (178 rules) - All BASIC rules - **European rules (BR-xx)**: 81 business rules - **French rules (FR-xx)**: 12 France-specific rules - **Advanced calculations (CR-xx)**: 32 calculation rules - **Standardized codes (CL-xx)**: 52 code lists ### EXTENDED (210+ rules) - All EN16931 rules - Logistics information - Advanced accounting data - Multiple external references ## Checks performed ### 1. Syntax validation - Correct XML parsing (UTF-8, well-formed) - UN/CEFACT namespaces present - Hierarchical structure respected ### 2. Business rules (BR-xx) Examples: - &#x60;BR-1&#x60;: Invoice total must equal sum of line totals + document-level amounts - &#x60;BR-CO-10&#x60;: Sum of VAT base amounts must equal invoice net total - &#x60;BR-16&#x60;: Invoice currency code must be in ISO 4217 list ### 3. French rules (FR-xx) Examples: - &#x60;FR-1&#x60;: Supplier SIRET must have 14 digits - &#x60;FR-2&#x60;: Customer SIRET must have 14 digits (if present) - &#x60;FR-5&#x60;: Intra-EU VAT number must be in format FRxx999999999 ### 4. Calculation rules (CR-xx) - Net + VAT &#x3D; Gross amounts - Sum of lines &#x3D; Document total - Discounts and surcharges correctly applied - Compliant rounding (2 decimals for amounts) ### 5. Standardized codes (CL-xx) - ISO 3166-1 alpha-2 country codes - ISO 4217 currency codes - UN/ECE Rec 20 measurement units - VAT codes (types, categories, exemptions) - SchemeID for identifiers (0002&#x3D;SIREN, 0009&#x3D;SIRET, etc.) ## Validation process 1. **XSLT loading**: Schematron file converted to XSLT (Saxon-HE) 2. **Transformation**: Rules applied to XML 3. **Results analysis**: Extraction of errors (&#x60;failed-assert&#x60;) and warnings (&#x60;successful-report&#x60;) 4. **Report**: Structured list of non-conformities ## Responses **200 OK**: Compliant XML &#x60;&#x60;&#x60;json { \&quot;message\&quot;: \&quot;XML is compliant with EN16931 profile\&quot; } &#x60;&#x60;&#x60; **400 Bad Request**: Non-compliant XML &#x60;&#x60;&#x60;json { \&quot;detail\&quot;: [ \&quot;[BR-1] Invoice total (120.00) does not match calculated sum (100.00 + 20.00)\&quot;, \&quot;[FR-1] Supplier SIRET must contain exactly 14 digits\&quot; ] } &#x60;&#x60;&#x60; ## Use cases - **Pre-validation**: Verify XML before PDF/A integration - **Debugging**: Precisely identify generation errors - **Testing**: Validate test or example XMLs - **Compliance**: Ensure European and French rules are met - **Development**: Quick testing without PDF generation ## Processing time - MINIMUM profile: ~0.5 second - EN16931 profile: ~1-2 seconds - EXTENDED profile: ~2-3 seconds
195
- # @param xml_file [File] Factur-X XML file to validate (.xml format).
196
- # @param [Hash] opts the optional parameters
197
- # @option opts [APIProfile] :profile Validation profile (MINIMUM, BASIC, EN16931, EXTENDED).
198
- # @option opts [Boolean] :skip_br_fr
199
- # @return [Array<(ValidationSuccessResponse, Integer, Hash)>] ValidationSuccessResponse data, response status code and response headers
200
- def validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts = {})
201
- if @api_client.config.debugging
202
- @api_client.config.logger.debug 'Calling API: FacturXValidationApi.validate_xml_api_v1_processing_validate_xml_post ...'
203
- end
204
- # verify the required parameter 'xml_file' is set
205
- if @api_client.config.client_side_validation && xml_file.nil?
206
- fail ArgumentError, "Missing the required parameter 'xml_file' when calling FacturXValidationApi.validate_xml_api_v1_processing_validate_xml_post"
207
- end
208
- # resource path
209
- local_var_path = '/api/v1/processing/validate-xml'
210
-
211
- # query parameters
212
- query_params = opts[:query_params] || {}
213
-
214
- # header parameters
215
- header_params = opts[:header_params] || {}
216
- # HTTP header 'Accept' (if needed)
217
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
218
- # HTTP header 'Content-Type'
219
- content_type = @api_client.select_header_content_type(['multipart/form-data'])
220
- if !content_type.nil?
221
- header_params['Content-Type'] = content_type
222
- end
223
-
224
- # form parameters
225
- form_params = opts[:form_params] || {}
226
- form_params['xml_file'] = xml_file
227
- form_params['profile'] = opts[:'profile'] if !opts[:'profile'].nil?
228
- form_params['skip_br_fr'] = opts[:'skip_br_fr'] if !opts[:'skip_br_fr'].nil?
229
-
230
- # http body (model)
231
- post_body = opts[:debug_body]
232
-
233
- # return_type
234
- return_type = opts[:debug_return_type] || 'ValidationSuccessResponse'
235
-
236
- # auth_names
237
- auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
238
-
239
- new_options = opts.merge(
240
- :operation => :"FacturXValidationApi.validate_xml_api_v1_processing_validate_xml_post",
241
- :header_params => header_params,
242
- :query_params => query_params,
243
- :form_params => form_params,
244
- :body => post_body,
245
- :auth_names => auth_names,
246
- :return_type => return_type
247
- )
248
-
249
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
250
- if @api_client.config.debugging
251
- @api_client.config.logger.debug "API called: FacturXValidationApi#validate_xml_api_v1_processing_validate_xml_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
252
- end
253
- return data, status_code, headers
254
- end
255
180
  end
256
181
  end
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - 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) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 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/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -82,6 +82,69 @@ module FactPulse
82
82
  return data, status_code, headers
83
83
  end
84
84
 
85
+ # Get typed status of an asynchronous verification
86
+ # Typed status endpoint for async verification tasks. Returns a strongly-typed `result` (discriminated on `result.status`): - **SUCCESS**: `VerificationSuccessTaskResult` with `verification_result` - **ERROR**: `TaskErrorResult` in AFNOR format
87
+ # @param task_id [String] Celery task ID returned by /verify-async endpoint
88
+ # @param [Hash] opts the optional parameters
89
+ # @return [VerificationTypedTaskStatus]
90
+ def get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get(task_id, opts = {})
91
+ data, _status_code, _headers = get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info(task_id, opts)
92
+ data
93
+ end
94
+
95
+ # Get typed status of an asynchronous verification
96
+ # Typed status endpoint for async verification tasks. Returns a strongly-typed &#x60;result&#x60; (discriminated on &#x60;result.status&#x60;): - **SUCCESS**: &#x60;VerificationSuccessTaskResult&#x60; with &#x60;verification_result&#x60; - **ERROR**: &#x60;TaskErrorResult&#x60; in AFNOR format
97
+ # @param task_id [String] Celery task ID returned by /verify-async endpoint
98
+ # @param [Hash] opts the optional parameters
99
+ # @return [Array<(VerificationTypedTaskStatus, Integer, Hash)>] VerificationTypedTaskStatus data, response status code and response headers
100
+ def get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get_with_http_info(task_id, opts = {})
101
+ if @api_client.config.debugging
102
+ @api_client.config.logger.debug 'Calling API: FacturXPDFXMLVerificationApi.get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get ...'
103
+ end
104
+ # verify the required parameter 'task_id' is set
105
+ if @api_client.config.client_side_validation && task_id.nil?
106
+ fail ArgumentError, "Missing the required parameter 'task_id' when calling FacturXPDFXMLVerificationApi.get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get"
107
+ end
108
+ # resource path
109
+ local_var_path = '/api/v1/verification/verify-async/{task_id}/typed-status'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))
110
+
111
+ # query parameters
112
+ query_params = opts[:query_params] || {}
113
+
114
+ # header parameters
115
+ header_params = opts[:header_params] || {}
116
+ # HTTP header 'Accept' (if needed)
117
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
118
+
119
+ # form parameters
120
+ form_params = opts[:form_params] || {}
121
+
122
+ # http body (model)
123
+ post_body = opts[:debug_body]
124
+
125
+ # return_type
126
+ return_type = opts[:debug_return_type] || 'VerificationTypedTaskStatus'
127
+
128
+ # auth_names
129
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
130
+
131
+ new_options = opts.merge(
132
+ :operation => :"FacturXPDFXMLVerificationApi.get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get",
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => return_type
139
+ )
140
+
141
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
142
+ if @api_client.config.debugging
143
+ @api_client.config.logger.debug "API called: FacturXPDFXMLVerificationApi#get_verification_typed_status_api_v1_verification_verify_async_task_id_typed_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ end
145
+ return data, status_code, headers
146
+ end
147
+
85
148
  # Verify PDF/XML Factur-X compliance (asynchronous)
86
149
  # Verifies PDF/XML Factur-X compliance asynchronously. **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will return a `NOT_FACTURX` error in the result. This version uses a Celery task and can call the OCR service if the PDF is an image or if `force_ocr=true`. **Returns immediately** a task ID. Use `/verify-async/{task_id}/status` to retrieve the result. **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency **Advantages over synchronous version:** - OCR support for image PDFs (via DocTR service) - Longer timeout for large documents - Doesn't block the server ## Webhook notification (recommended) Instead of polling, you can receive a webhook notification when verification completes: ``` callback_url=https://your-server.com/webhook ``` The webhook will POST a JSON payload with: - `event_type`: `verification.completed` or `verification.failed` - `data.is_compliant`: Whether the PDF/XML are consistent - `data.compliance_score`: Compliance score (0-1) - `X-Webhook-Signature` header for HMAC verification
87
150
  # @param pdf_file [File] Factur-X PDF file to verify
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - 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) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 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/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -1,12 +1,12 @@
1
1
  =begin
2
2
  #FactPulse REST API
3
3
 
4
- # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X - 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) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ # REST API for electronic invoicing in France: Factur-X (CII), UBL 2.1, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Invoice Generation - **Formats**: CII XML, UBL 2.1 XML, or Factur-X PDF/A-3 - **Profiles** (CII/PDF): MINIMUM, BASIC, EN16931, EXTENDED - **UBL**: Always EN16931 compliant - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT), UBL 2.1 (OASIS) - **Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ 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 ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## 🔒 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/
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: contact@factpulse.fr
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.20.0-SNAPSHOT
9
+ Generator version: 7.21.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -144,6 +144,89 @@ module FactPulse
144
144
  return data, status_code, headers
145
145
  end
146
146
 
147
+ # [Simplified] Get lifecycle events for invoices
148
+ # Returns lifecycle events (CDAR) grouped by invoice reference. **How it works (AFNOR XP Z12-013 compliant):** 1. Searches lifecycle flows on the PDP by flowType + flowDirection + date range 2. Downloads and parses each CDAR XML to extract the invoice reference 3. Groups events by invoice, sorted chronologically **Parameters:** - `days`: Number of days to look back (default: 7) - `invoiceId`: Optional filter on a specific invoice reference **Authentication:** JWT Bearer (recommended) or PDP credentials as query parameters.
149
+ # @param [Hash] opts the optional parameters
150
+ # @option opts [Integer] :days Number of days to look back (default to 7)
151
+ # @option opts [String] :invoice_id Filter by invoice reference
152
+ # @option opts [String] :pdp_flow_service_url PDP Flow Service URL
153
+ # @option opts [String] :pdp_token_url PDP OAuth token URL
154
+ # @option opts [String] :pdp_client_id PDP Client ID
155
+ # @option opts [String] :pdp_client_secret PDP Client Secret
156
+ # @return [LifecycleResponse]
157
+ def get_lifecycle_api_v1_cdar_lifecycle_get(opts = {})
158
+ data, _status_code, _headers = get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info(opts)
159
+ data
160
+ end
161
+
162
+ # [Simplified] Get lifecycle events for invoices
163
+ # Returns lifecycle events (CDAR) grouped by invoice reference. **How it works (AFNOR XP Z12-013 compliant):** 1. Searches lifecycle flows on the PDP by flowType + flowDirection + date range 2. Downloads and parses each CDAR XML to extract the invoice reference 3. Groups events by invoice, sorted chronologically **Parameters:** - &#x60;days&#x60;: Number of days to look back (default: 7) - &#x60;invoiceId&#x60;: Optional filter on a specific invoice reference **Authentication:** JWT Bearer (recommended) or PDP credentials as query parameters.
164
+ # @param [Hash] opts the optional parameters
165
+ # @option opts [Integer] :days Number of days to look back (default to 7)
166
+ # @option opts [String] :invoice_id Filter by invoice reference
167
+ # @option opts [String] :pdp_flow_service_url PDP Flow Service URL
168
+ # @option opts [String] :pdp_token_url PDP OAuth token URL
169
+ # @option opts [String] :pdp_client_id PDP Client ID
170
+ # @option opts [String] :pdp_client_secret PDP Client Secret
171
+ # @return [Array<(LifecycleResponse, Integer, Hash)>] LifecycleResponse data, response status code and response headers
172
+ def get_lifecycle_api_v1_cdar_lifecycle_get_with_http_info(opts = {})
173
+ if @api_client.config.debugging
174
+ @api_client.config.logger.debug 'Calling API: Flux6InvoiceLifecycleCDARApi.get_lifecycle_api_v1_cdar_lifecycle_get ...'
175
+ end
176
+ if @api_client.config.client_side_validation && !opts[:'days'].nil? && opts[:'days'] > 365
177
+ fail ArgumentError, 'invalid value for "opts[:"days"]" when calling Flux6InvoiceLifecycleCDARApi.get_lifecycle_api_v1_cdar_lifecycle_get, must be smaller than or equal to 365.'
178
+ end
179
+
180
+ if @api_client.config.client_side_validation && !opts[:'days'].nil? && opts[:'days'] < 1
181
+ fail ArgumentError, 'invalid value for "opts[:"days"]" when calling Flux6InvoiceLifecycleCDARApi.get_lifecycle_api_v1_cdar_lifecycle_get, must be greater than or equal to 1.'
182
+ end
183
+
184
+ # resource path
185
+ local_var_path = '/api/v1/cdar/lifecycle'
186
+
187
+ # query parameters
188
+ query_params = opts[:query_params] || {}
189
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
190
+ query_params[:'invoiceId'] = opts[:'invoice_id'] if !opts[:'invoice_id'].nil?
191
+ query_params[:'pdpFlowServiceUrl'] = opts[:'pdp_flow_service_url'] if !opts[:'pdp_flow_service_url'].nil?
192
+ query_params[:'pdpTokenUrl'] = opts[:'pdp_token_url'] if !opts[:'pdp_token_url'].nil?
193
+ query_params[:'pdpClientId'] = opts[:'pdp_client_id'] if !opts[:'pdp_client_id'].nil?
194
+ query_params[:'pdpClientSecret'] = opts[:'pdp_client_secret'] if !opts[:'pdp_client_secret'].nil?
195
+
196
+ # header parameters
197
+ header_params = opts[:header_params] || {}
198
+ # HTTP header 'Accept' (if needed)
199
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
200
+
201
+ # form parameters
202
+ form_params = opts[:form_params] || {}
203
+
204
+ # http body (model)
205
+ post_body = opts[:debug_body]
206
+
207
+ # return_type
208
+ return_type = opts[:debug_return_type] || 'LifecycleResponse'
209
+
210
+ # auth_names
211
+ auth_names = opts[:debug_auth_names] || ['HTTPBearer']
212
+
213
+ new_options = opts.merge(
214
+ :operation => :"Flux6InvoiceLifecycleCDARApi.get_lifecycle_api_v1_cdar_lifecycle_get",
215
+ :header_params => header_params,
216
+ :query_params => query_params,
217
+ :form_params => form_params,
218
+ :body => post_body,
219
+ :auth_names => auth_names,
220
+ :return_type => return_type
221
+ )
222
+
223
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
224
+ if @api_client.config.debugging
225
+ @api_client.config.logger.debug "API called: Flux6InvoiceLifecycleCDARApi#get_lifecycle_api_v1_cdar_lifecycle_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
226
+ end
227
+ return data, status_code, headers
228
+ end
229
+
147
230
  # List of CDAR reason codes
148
231
  # Returns the complete list of status reason codes (BR-FR-CDV-CL-09). These codes explain the reason for a particular status.
149
232
  # @param [Hash] opts the optional parameters