factpulse 4.0.3 → 4.3.0

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 (510) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -5
  3. data/Gemfile.lock +3 -3
  4. data/docs/AFNORBasicAuthentication.md +20 -0
  5. data/docs/AFNORCallbackAuthentication.md +49 -0
  6. data/docs/AFNORCallbackHeader.md +20 -0
  7. data/docs/AFNORCallbackParameters.md +24 -0
  8. data/docs/AFNORCallbackSignature.md +20 -0
  9. data/docs/{AFNORFacilityNature.md → AFNORContainsOrStrictOperator.md} +2 -2
  10. data/docs/AFNORCoreFlowInfo.md +26 -0
  11. data/docs/{AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md → AFNORDirectoryLinePayloadLegalUnitFacilityRoutingCode.md} +5 -5
  12. data/docs/AFNORDirectoryLinePayloadStatusLegalUnitFacilityRoutingCode.md +34 -0
  13. data/docs/AFNORDirectoryLineSearchPost200Response.md +1 -1
  14. data/docs/{AFNORDiffusionStatus.md → AFNORDirectoryLineStatus.md} +2 -2
  15. data/docs/AFNORError.md +4 -4
  16. data/docs/AFNORErrorDetail.md +26 -0
  17. data/docs/AFNORFacilityPayloadHistory.md +3 -3
  18. data/docs/AFNORFacilityPayloadIncluded.md +0 -2
  19. data/docs/AFNORFlow.md +16 -14
  20. data/docs/AFNORFlowExtension.md +26 -0
  21. data/docs/AFNORFlowInfo.md +3 -3
  22. data/docs/AFNORFlowInfoExtension.md +18 -0
  23. data/docs/AFNORFullFlowInfo.md +8 -8
  24. data/docs/AFNORFullFlowInfoExtension.md +20 -0
  25. data/docs/AFNORLegalUnitPayloadHistory.md +3 -1
  26. data/docs/AFNOROAuth2Authentication.md +22 -0
  27. data/docs/AFNORPDPPADirectoryServiceApi.md +4 -648
  28. data/docs/AFNORPDPPAFlowServiceApi.md +320 -1
  29. data/docs/AFNORRoutingCodeSearch.md +1 -1
  30. data/docs/AFNORRoutingCodeSearchFiltersRoutingCodeName.md +1 -1
  31. data/docs/AFNORRoutingCodeSearchFiltersRoutingIdentifier.md +1 -1
  32. data/docs/AFNORSearchDirectoryLine.md +2 -2
  33. data/docs/AFNORSearchDirectoryLineFiltersAddressingIdentifier.md +1 -1
  34. data/docs/AFNORSearchDirectoryLineFiltersAddressingSuffix.md +1 -1
  35. data/docs/AFNORSearchFlowFilters.md +1 -1
  36. data/docs/AFNORSearchSiren.md +1 -1
  37. data/docs/AFNORSearchSirenFiltersBusinessName.md +1 -1
  38. data/docs/AFNORSearchSirenFiltersSiren.md +1 -1
  39. data/docs/AFNORSearchSiret.md +2 -2
  40. data/docs/AFNORSearchSiretFiltersCountrySubdivision.md +1 -1
  41. data/docs/AFNORSearchSiretFiltersFacilityType.md +1 -1
  42. data/docs/AFNORSearchSiretFiltersLocality.md +1 -1
  43. data/docs/AFNORSearchSiretFiltersName.md +1 -1
  44. data/docs/AFNORSearchSiretFiltersPostalCode.md +1 -1
  45. data/docs/AFNORSearchSiretFiltersSiret.md +1 -1
  46. data/docs/AFNORSirenInstructions.md +18 -0
  47. data/docs/AFNORSiretInstructions.md +18 -0
  48. data/docs/{AFNORPlatformStatus.md → AFNORStrictOrStartWithOperator.md} +2 -2
  49. data/docs/AFNORWebhook.md +22 -0
  50. data/docs/AFNORWebhookIdParam.md +18 -0
  51. data/docs/AFNORWebhookMetadata.md +24 -0
  52. data/docs/AFNORWebhookParams.md +20 -0
  53. data/docs/AFNORWebhookPatchPayload.md +22 -0
  54. data/docs/AsyncTasksApi.md +225 -0
  55. data/docs/ChorusProCredentials.md +8 -8
  56. data/docs/ChorusProDestination.md +1 -1
  57. data/docs/ClientManagementApi.md +20 -20
  58. data/docs/ConversionErrorResult.md +30 -0
  59. data/docs/ConversionExtractionInfo.md +20 -0
  60. data/docs/ConversionPendingInputResult.md +30 -0
  61. data/docs/ConversionSuccessTaskResult.md +36 -0
  62. data/docs/ConversionTaskStatus.md +22 -0
  63. data/docs/ConversionTaskStatusResult.md +85 -0
  64. data/docs/ConversionValidationFailedResult.md +34 -0
  65. data/docs/DownloadsApi.md +4 -4
  66. data/docs/FacturXConversionApi.md +75 -0
  67. data/docs/FacturXInvoice.md +1 -1
  68. data/docs/FacturXPDFXMLVerificationApi.md +75 -0
  69. data/docs/FacturXValidationApi.md +0 -81
  70. data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +24 -0
  71. data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +26 -0
  72. data/docs/Flux6InvoiceLifecycleCDARApi.md +82 -0
  73. data/docs/GenerationSuccessResult.md +24 -0
  74. data/docs/GenerationTaskStatus.md +22 -0
  75. data/docs/GenerationTaskStatusResult.md +79 -0
  76. data/docs/GetChorusProIdRequest.md +1 -1
  77. data/docs/GetInvoiceRequest.md +1 -1
  78. data/docs/GetStructureRequest.md +1 -1
  79. data/docs/HealthApi.md +0 -124
  80. data/docs/{FacturXGenerationApi.md → InvoiceGenerationApi.md} +21 -21
  81. data/docs/InvoiceLifecycle.md +24 -0
  82. data/docs/InvoicingFramework.md +1 -1
  83. data/docs/LifecycleEvent.md +38 -0
  84. data/docs/LifecycleResponse.md +22 -0
  85. data/docs/ParseApi.md +161 -0
  86. data/docs/ParseFacturXResponse.md +26 -0
  87. data/docs/ReferencesApi.md +74 -0
  88. data/docs/SearchStructureRequest.md +1 -1
  89. data/docs/SignatureSuccessResult.md +34 -0
  90. data/docs/SignatureTaskStatus.md +22 -0
  91. data/docs/SignatureTaskStatusResult.md +79 -0
  92. data/docs/SubmitCompleteInvoiceResponse.md +3 -1
  93. data/docs/SubmitInvoiceRequest.md +1 -1
  94. data/docs/Supplier.md +1 -1
  95. data/docs/TaskErrorResult.md +26 -0
  96. data/docs/VATEXCodeInfo.md +24 -0
  97. data/docs/VATEXCodesResponse.md +22 -0
  98. data/docs/ValidateCDARResponse.md +2 -2
  99. data/docs/ValidationApi.md +88 -0
  100. data/docs/ValidationErrorResponse.md +2 -8
  101. data/docs/ValidationSuccessTaskResult.md +20 -0
  102. data/docs/ValidationTaskStatus.md +22 -0
  103. data/docs/ValidationTaskStatusResult.md +79 -0
  104. data/docs/VerificationSuccessTaskResult.md +20 -0
  105. data/docs/VerificationTypedTaskStatus.md +22 -0
  106. data/docs/VerificationTypedTaskStatusResult.md +79 -0
  107. data/factpulse.gemspec +3 -3
  108. data/lib/factpulse/api/afnorpdppa_api.rb +2 -2
  109. data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +5 -623
  110. data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +305 -2
  111. data/lib/factpulse/api/async_tasks_api.rb +191 -2
  112. data/lib/factpulse/api/chorus_pro_api.rb +2 -2
  113. data/lib/factpulse/api/client_management_api.rb +22 -22
  114. data/lib/factpulse/api/downloads_api.rb +6 -6
  115. data/lib/factpulse/api/electronic_signature_api.rb +2 -2
  116. data/lib/factpulse/api/factur_x_conversion_api.rb +65 -2
  117. data/lib/factpulse/api/factur_x_validation_api.rb +2 -77
  118. data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +65 -2
  119. data/lib/factpulse/api/flux10_e_reporting_api.rb +2 -2
  120. data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +85 -2
  121. data/lib/factpulse/api/health_api.rb +2 -116
  122. data/lib/factpulse/api/{factur_x_generation_api.rb → invoice_generation_api.rb} +23 -23
  123. data/lib/factpulse/api/parse_api.rb +163 -0
  124. data/lib/factpulse/api/references_api.rb +82 -0
  125. data/lib/factpulse/api/validation_api.rb +97 -0
  126. data/lib/factpulse/api_client.rb +2 -2
  127. data/lib/factpulse/api_error.rb +2 -2
  128. data/lib/factpulse/api_model_base.rb +2 -2
  129. data/lib/factpulse/configuration.rb +2 -2
  130. data/lib/factpulse/models/acknowledgment_status.rb +2 -2
  131. data/lib/factpulse/models/action_code_info.rb +2 -2
  132. data/lib/factpulse/models/action_codes_response.rb +2 -2
  133. data/lib/factpulse/models/additional_document.rb +2 -2
  134. data/lib/factpulse/models/afnor_acknowledgement.rb +2 -2
  135. data/lib/factpulse/models/afnor_acknowledgement_detail.rb +2 -2
  136. data/lib/factpulse/models/afnor_address_read.rb +2 -2
  137. data/lib/factpulse/models/afnor_algorithm.rb +6 -5
  138. data/lib/factpulse/models/afnor_basic_authentication.rb +190 -0
  139. data/lib/factpulse/models/afnor_callback_authentication.rb +105 -0
  140. data/lib/factpulse/models/afnor_callback_header.rb +190 -0
  141. data/lib/factpulse/models/afnor_callback_parameters.rb +193 -0
  142. data/lib/factpulse/models/afnor_callback_signature.rb +213 -0
  143. data/lib/factpulse/models/afnor_contains_operator.rb +2 -2
  144. data/lib/factpulse/models/afnor_contains_or_strict_operator.rb +40 -0
  145. data/lib/factpulse/models/afnor_core_flow_info.rb +270 -0
  146. data/lib/factpulse/models/afnor_credentials.rb +2 -2
  147. data/lib/factpulse/models/afnor_destination.rb +2 -2
  148. data/lib/factpulse/models/afnor_directory_line_field.rb +3 -4
  149. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_routing_code.rb +2 -2
  150. data/lib/factpulse/models/{afnor_directory_line_payload_history_legal_unit_facility_routing_code.rb → afnor_directory_line_payload_legal_unit_facility_routing_code.rb} +38 -16
  151. data/lib/factpulse/models/afnor_directory_line_payload_status_legal_unit_facility_routing_code.rb +343 -0
  152. data/lib/factpulse/models/afnor_directory_line_search_post200_response.rb +3 -3
  153. data/lib/factpulse/models/afnor_directory_line_status.rb +41 -0
  154. data/lib/factpulse/models/afnor_entity_type.rb +2 -2
  155. data/lib/factpulse/models/afnor_error.rb +32 -41
  156. data/lib/factpulse/models/afnor_error_detail.rb +237 -0
  157. data/lib/factpulse/models/afnor_facility_administrative_status.rb +2 -2
  158. data/lib/factpulse/models/afnor_facility_payload_history.rb +13 -13
  159. data/lib/factpulse/models/afnor_facility_payload_history_ule_b2g_additional_data.rb +2 -2
  160. data/lib/factpulse/models/afnor_facility_payload_included.rb +3 -12
  161. data/lib/factpulse/models/afnor_facility_type.rb +2 -2
  162. data/lib/factpulse/models/afnor_flow.rb +220 -59
  163. data/lib/factpulse/models/afnor_flow_ack_status.rb +2 -2
  164. data/lib/factpulse/models/afnor_flow_direction.rb +2 -2
  165. data/lib/factpulse/models/afnor_flow_extension.rb +295 -0
  166. data/lib/factpulse/models/afnor_flow_info.rb +22 -6
  167. data/lib/factpulse/models/afnor_flow_info_extension.rb +170 -0
  168. data/lib/factpulse/models/afnor_flow_profile.rb +2 -2
  169. data/lib/factpulse/models/afnor_flow_syntax.rb +2 -2
  170. data/lib/factpulse/models/afnor_flow_type.rb +2 -2
  171. data/lib/factpulse/models/afnor_full_flow_info.rb +81 -48
  172. data/lib/factpulse/models/afnor_full_flow_info_extension.rb +202 -0
  173. data/lib/factpulse/models/afnor_health_check_response.rb +2 -2
  174. data/lib/factpulse/models/afnor_legal_unit_administrative_status.rb +2 -2
  175. data/lib/factpulse/models/afnor_legal_unit_payload_history.rb +15 -6
  176. data/lib/factpulse/models/afnor_legal_unit_payload_included.rb +2 -2
  177. data/lib/factpulse/models/afnor_processing_rule.rb +6 -3
  178. data/lib/factpulse/models/afnor_reason_code.rb +2 -2
  179. data/lib/factpulse/models/afnor_reason_code_enum.rb +2 -2
  180. data/lib/factpulse/models/afnor_recipient_platform_type.rb +2 -2
  181. data/lib/factpulse/models/afnor_result.rb +2 -2
  182. data/lib/factpulse/models/afnor_routing_code_administrative_status.rb +2 -2
  183. data/lib/factpulse/models/afnor_routing_code_field.rb +3 -4
  184. data/lib/factpulse/models/afnor_routing_code_payload_history_legal_unit_facility.rb +2 -2
  185. data/lib/factpulse/models/afnor_routing_code_search.rb +2 -2
  186. data/lib/factpulse/models/afnor_routing_code_search_filters.rb +2 -2
  187. data/lib/factpulse/models/afnor_routing_code_search_filters_administrative_status.rb +2 -2
  188. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_code_name.rb +3 -3
  189. data/lib/factpulse/models/afnor_routing_code_search_filters_routing_identifier.rb +3 -3
  190. data/lib/factpulse/models/afnor_routing_code_search_post200_response.rb +2 -2
  191. data/lib/factpulse/models/afnor_routing_code_search_sorting_inner.rb +2 -2
  192. data/lib/factpulse/models/afnor_search_directory_line.rb +2 -2
  193. data/lib/factpulse/models/afnor_search_directory_line_filters.rb +2 -2
  194. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_identifier.rb +3 -3
  195. data/lib/factpulse/models/afnor_search_directory_line_filters_addressing_suffix.rb +3 -3
  196. data/lib/factpulse/models/afnor_search_directory_line_sorting_inner.rb +2 -2
  197. data/lib/factpulse/models/afnor_search_flow_content.rb +2 -2
  198. data/lib/factpulse/models/afnor_search_flow_filters.rb +3 -2
  199. data/lib/factpulse/models/afnor_search_flow_params.rb +2 -2
  200. data/lib/factpulse/models/afnor_search_siren.rb +2 -2
  201. data/lib/factpulse/models/afnor_search_siren_filters.rb +2 -2
  202. data/lib/factpulse/models/afnor_search_siren_filters_administrative_status.rb +2 -2
  203. data/lib/factpulse/models/afnor_search_siren_filters_business_name.rb +3 -3
  204. data/lib/factpulse/models/afnor_search_siren_filters_entity_type.rb +2 -2
  205. data/lib/factpulse/models/afnor_search_siren_filters_siren.rb +3 -3
  206. data/lib/factpulse/models/afnor_search_siren_sorting_inner.rb +2 -2
  207. data/lib/factpulse/models/afnor_search_siret.rb +2 -2
  208. data/lib/factpulse/models/afnor_search_siret_filters.rb +2 -2
  209. data/lib/factpulse/models/afnor_search_siret_filters_address_lines.rb +2 -2
  210. data/lib/factpulse/models/afnor_search_siret_filters_administrative_status.rb +2 -2
  211. data/lib/factpulse/models/afnor_search_siret_filters_country_subdivision.rb +3 -3
  212. data/lib/factpulse/models/afnor_search_siret_filters_facility_type.rb +3 -3
  213. data/lib/factpulse/models/afnor_search_siret_filters_locality.rb +3 -3
  214. data/lib/factpulse/models/afnor_search_siret_filters_name.rb +3 -3
  215. data/lib/factpulse/models/afnor_search_siret_filters_postal_code.rb +3 -3
  216. data/lib/factpulse/models/afnor_search_siret_filters_siret.rb +3 -3
  217. data/lib/factpulse/models/afnor_search_siret_sorting_inner.rb +2 -2
  218. data/lib/factpulse/models/afnor_siren_field.rb +4 -4
  219. data/lib/factpulse/models/afnor_siren_instructions.rb +149 -0
  220. data/lib/factpulse/models/afnor_siren_search_post200_response.rb +2 -2
  221. data/lib/factpulse/models/afnor_siret_field.rb +5 -6
  222. data/lib/factpulse/models/afnor_siret_instructions.rb +149 -0
  223. data/lib/factpulse/models/afnor_siret_search_post200_response.rb +2 -2
  224. data/lib/factpulse/models/afnor_sorting_order.rb +2 -2
  225. data/lib/factpulse/models/afnor_strict_operator.rb +2 -2
  226. data/lib/factpulse/models/afnor_strict_or_start_with_operator.rb +40 -0
  227. data/lib/factpulse/models/afnor_webhook.rb +207 -0
  228. data/lib/factpulse/models/afnor_webhook_id_param.rb +147 -0
  229. data/lib/factpulse/models/afnor_webhook_metadata.rb +230 -0
  230. data/lib/factpulse/models/afnor_webhook_params.rb +190 -0
  231. data/lib/factpulse/models/afnor_webhook_patch_payload.rb +167 -0
  232. data/lib/factpulse/models/afnoro_auth2_authentication.rb +216 -0
  233. data/lib/factpulse/models/aggregated_payment_input.rb +2 -2
  234. data/lib/factpulse/models/aggregated_transaction_input.rb +2 -2
  235. data/lib/factpulse/models/allowance_charge.rb +2 -2
  236. data/lib/factpulse/models/allowance_charge_reason_code.rb +2 -2
  237. data/lib/factpulse/models/allowance_reason_code.rb +2 -2
  238. data/lib/factpulse/models/allowance_total_amount.rb +2 -2
  239. data/lib/factpulse/models/amount.rb +2 -2
  240. data/lib/factpulse/models/amount1.rb +2 -2
  241. data/lib/factpulse/models/amount2.rb +2 -2
  242. data/lib/factpulse/models/amount_due.rb +2 -2
  243. data/lib/factpulse/models/api_error.rb +2 -2
  244. data/lib/factpulse/models/api_profile.rb +2 -2
  245. data/lib/factpulse/models/async_task_status.rb +2 -2
  246. data/lib/factpulse/models/base_amount.rb +2 -2
  247. data/lib/factpulse/models/bounding_box_schema.rb +2 -2
  248. data/lib/factpulse/models/buyercountry.rb +2 -2
  249. data/lib/factpulse/models/celery_status.rb +2 -2
  250. data/lib/factpulse/models/certificate_info_response.rb +2 -2
  251. data/lib/factpulse/models/charge_total_amount.rb +2 -2
  252. data/lib/factpulse/models/chorus_pro_credentials.rb +96 -28
  253. data/lib/factpulse/models/chorus_pro_destination.rb +3 -3
  254. data/lib/factpulse/models/chorus_pro_result.rb +2 -2
  255. data/lib/factpulse/models/client_activate_response.rb +2 -2
  256. data/lib/factpulse/models/client_create_request.rb +2 -2
  257. data/lib/factpulse/models/client_detail.rb +2 -2
  258. data/lib/factpulse/models/client_list_response.rb +2 -2
  259. data/lib/factpulse/models/client_summary.rb +2 -2
  260. data/lib/factpulse/models/client_update_request.rb +2 -2
  261. data/lib/factpulse/models/contact.rb +2 -2
  262. data/lib/factpulse/models/conversion_error_result.rb +277 -0
  263. data/lib/factpulse/models/conversion_extraction_info.rb +176 -0
  264. data/lib/factpulse/models/conversion_pending_input_result.rb +344 -0
  265. data/lib/factpulse/models/conversion_success_task_result.rb +355 -0
  266. data/lib/factpulse/models/conversion_task_status.rb +223 -0
  267. data/lib/factpulse/models/conversion_task_status_result.rb +59 -0
  268. data/lib/factpulse/models/conversion_validation_failed_result.rb +348 -0
  269. data/lib/factpulse/models/convert_resume_request.rb +2 -2
  270. data/lib/factpulse/models/convert_success_response.rb +2 -2
  271. data/lib/factpulse/models/convert_validation_failed_response.rb +2 -2
  272. data/lib/factpulse/models/country_code.rb +2 -2
  273. data/lib/factpulse/models/create_aggregated_report_request.rb +2 -2
  274. data/lib/factpulse/models/create_cdar_request.rb +2 -2
  275. data/lib/factpulse/models/create_e_reporting_request.rb +2 -2
  276. data/lib/factpulse/models/currency.rb +2 -2
  277. data/lib/factpulse/models/currency_code.rb +2 -2
  278. data/lib/factpulse/models/delivery_party.rb +2 -2
  279. data/lib/factpulse/models/destination.rb +2 -2
  280. data/lib/factpulse/models/doc_type.rb +2 -2
  281. data/lib/factpulse/models/document_type_info.rb +2 -2
  282. data/lib/factpulse/models/e_reporting_flow_type.rb +2 -2
  283. data/lib/factpulse/models/e_reporting_validation_error.rb +2 -2
  284. data/lib/factpulse/models/electronic_address.rb +2 -2
  285. data/lib/factpulse/models/encaisseamount.rb +2 -2
  286. data/lib/factpulse/models/encaisseamount1.rb +2 -2
  287. data/lib/factpulse/models/encaissee_request.rb +2 -2
  288. data/lib/factpulse/models/enriched_invoice_info.rb +2 -2
  289. data/lib/factpulse/models/error_level.rb +2 -2
  290. data/lib/factpulse/models/error_source.rb +2 -2
  291. data/lib/factpulse/models/extraction_info.rb +2 -2
  292. data/lib/factpulse/models/factur_x_invoice.rb +3 -19
  293. data/lib/factpulse/models/factur_xpdf_info.rb +2 -2
  294. data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +215 -0
  295. data/lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb +2 -2
  296. data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +191 -0
  297. data/lib/factpulse/models/field_status.rb +2 -2
  298. data/lib/factpulse/models/file_info.rb +2 -2
  299. data/lib/factpulse/models/files_info.rb +2 -2
  300. data/lib/factpulse/models/flow_direction.rb +2 -2
  301. data/lib/factpulse/models/flow_profile.rb +2 -2
  302. data/lib/factpulse/models/flow_summary.rb +2 -2
  303. data/lib/factpulse/models/flow_syntax.rb +2 -2
  304. data/lib/factpulse/models/flow_type.rb +2 -2
  305. data/lib/factpulse/models/generate_aggregated_report_response.rb +2 -2
  306. data/lib/factpulse/models/generate_cdar_response.rb +2 -2
  307. data/lib/factpulse/models/generate_certificate_request.rb +2 -2
  308. data/lib/factpulse/models/generate_certificate_response.rb +2 -2
  309. data/lib/factpulse/models/generate_e_reporting_response.rb +2 -2
  310. data/lib/factpulse/models/generation_success_result.rb +230 -0
  311. data/lib/factpulse/models/generation_task_status.rb +223 -0
  312. data/lib/factpulse/models/generation_task_status_result.rb +55 -0
  313. data/lib/factpulse/models/get_chorus_pro_id_request.rb +3 -3
  314. data/lib/factpulse/models/get_chorus_pro_id_response.rb +2 -2
  315. data/lib/factpulse/models/get_invoice_request.rb +3 -3
  316. data/lib/factpulse/models/get_invoice_response.rb +2 -2
  317. data/lib/factpulse/models/get_structure_request.rb +3 -3
  318. data/lib/factpulse/models/get_structure_response.rb +2 -2
  319. data/lib/factpulse/models/global_allowance_amount.rb +2 -2
  320. data/lib/factpulse/models/gross_unit_price.rb +2 -2
  321. data/lib/factpulse/models/http_validation_error.rb +2 -2
  322. data/lib/factpulse/models/incoming_invoice.rb +2 -2
  323. data/lib/factpulse/models/incoming_supplier.rb +2 -2
  324. data/lib/factpulse/models/invoice_format.rb +2 -2
  325. data/lib/factpulse/models/invoice_input.rb +2 -2
  326. data/lib/factpulse/models/invoice_lifecycle.rb +215 -0
  327. data/lib/factpulse/models/invoice_line.rb +2 -2
  328. data/lib/factpulse/models/invoice_line_allowance_amount.rb +2 -2
  329. data/lib/factpulse/models/invoice_note.rb +2 -2
  330. data/lib/factpulse/models/invoice_payment_input.rb +2 -2
  331. data/lib/factpulse/models/invoice_references.rb +2 -2
  332. data/lib/factpulse/models/invoice_status.rb +2 -2
  333. data/lib/factpulse/models/invoice_totals.rb +2 -2
  334. data/lib/factpulse/models/invoice_totals_prepayment.rb +2 -2
  335. data/lib/factpulse/models/invoice_type_code.rb +2 -2
  336. data/lib/factpulse/models/invoice_type_code_output.rb +2 -2
  337. data/lib/factpulse/models/invoicing_framework.rb +3 -20
  338. data/lib/factpulse/models/invoicing_framework_code.rb +2 -2
  339. data/lib/factpulse/models/issuer_role_code.rb +2 -2
  340. data/lib/factpulse/models/key_rotation_request.rb +2 -2
  341. data/lib/factpulse/models/key_rotation_response.rb +2 -2
  342. data/lib/factpulse/models/lifecycle_event.rb +300 -0
  343. data/lib/factpulse/models/lifecycle_response.rb +205 -0
  344. data/lib/factpulse/models/line_net_amount.rb +2 -2
  345. data/lib/factpulse/models/line_sub_type.rb +2 -2
  346. data/lib/factpulse/models/line_total_amount.rb +2 -2
  347. data/lib/factpulse/models/location_inner.rb +2 -2
  348. data/lib/factpulse/models/mandatory_note_schema.rb +2 -2
  349. data/lib/factpulse/models/manual_rate.rb +2 -2
  350. data/lib/factpulse/models/manual_vat_rate.rb +2 -2
  351. data/lib/factpulse/models/missing_field.rb +2 -2
  352. data/lib/factpulse/models/operation_nature.rb +2 -2
  353. data/lib/factpulse/models/output_format.rb +5 -3
  354. data/lib/factpulse/models/page_dimensions_schema.rb +2 -2
  355. data/lib/factpulse/models/parse_factur_x_response.rb +249 -0
  356. data/lib/factpulse/models/payee.rb +2 -2
  357. data/lib/factpulse/models/payment_amount_by_rate.rb +2 -2
  358. data/lib/factpulse/models/payment_card.rb +2 -2
  359. data/lib/factpulse/models/payment_means.rb +2 -2
  360. data/lib/factpulse/models/pdf_validation_result_api.rb +2 -2
  361. data/lib/factpulse/models/pdp_config_response.rb +2 -2
  362. data/lib/factpulse/models/pdp_config_update_request.rb +2 -2
  363. data/lib/factpulse/models/pdp_credentials.rb +2 -2
  364. data/lib/factpulse/models/percentage.rb +2 -2
  365. data/lib/factpulse/models/postal_address.rb +2 -2
  366. data/lib/factpulse/models/price_allowance_amount.rb +2 -2
  367. data/lib/factpulse/models/price_basis_quantity.rb +2 -2
  368. data/lib/factpulse/models/processing_options.rb +2 -2
  369. data/lib/factpulse/models/processing_rule.rb +6 -3
  370. data/lib/factpulse/models/product_characteristic.rb +2 -2
  371. data/lib/factpulse/models/product_classification.rb +2 -2
  372. data/lib/factpulse/models/quantity.rb +2 -2
  373. data/lib/factpulse/models/rate.rb +2 -2
  374. data/lib/factpulse/models/rate1.rb +2 -2
  375. data/lib/factpulse/models/reason_code_info.rb +2 -2
  376. data/lib/factpulse/models/reason_codes_response.rb +2 -2
  377. data/lib/factpulse/models/recipient.rb +2 -2
  378. data/lib/factpulse/models/recipient_input.rb +2 -2
  379. data/lib/factpulse/models/refusee_request.rb +2 -2
  380. data/lib/factpulse/models/report_issuer.rb +2 -2
  381. data/lib/factpulse/models/report_period.rb +2 -2
  382. data/lib/factpulse/models/report_sender.rb +2 -2
  383. data/lib/factpulse/models/rounding_amount.rb +2 -2
  384. data/lib/factpulse/models/schematron_validation_error.rb +2 -2
  385. data/lib/factpulse/models/scheme_id.rb +2 -2
  386. data/lib/factpulse/models/search_flow_request.rb +2 -2
  387. data/lib/factpulse/models/search_flow_response.rb +2 -2
  388. data/lib/factpulse/models/search_services_response.rb +2 -2
  389. data/lib/factpulse/models/search_structure_request.rb +3 -3
  390. data/lib/factpulse/models/search_structure_response.rb +2 -2
  391. data/lib/factpulse/models/secret_status.rb +2 -2
  392. data/lib/factpulse/models/sellercountry.rb +2 -2
  393. data/lib/factpulse/models/signature_info.rb +2 -2
  394. data/lib/factpulse/models/signature_info_api.rb +2 -2
  395. data/lib/factpulse/models/signature_parameters.rb +2 -2
  396. data/lib/factpulse/models/signature_success_result.rb +394 -0
  397. data/lib/factpulse/models/signature_task_status.rb +223 -0
  398. data/lib/factpulse/models/signature_task_status_result.rb +55 -0
  399. data/lib/factpulse/models/simplified_cdar_response.rb +2 -2
  400. data/lib/factpulse/models/simplified_invoice_data.rb +2 -2
  401. data/lib/factpulse/models/status_code_info.rb +2 -2
  402. data/lib/factpulse/models/status_codes_response.rb +2 -2
  403. data/lib/factpulse/models/structure_info.rb +2 -2
  404. data/lib/factpulse/models/structure_parameters.rb +2 -2
  405. data/lib/factpulse/models/structure_service.rb +2 -2
  406. data/lib/factpulse/models/submission_mode.rb +2 -2
  407. data/lib/factpulse/models/submit_aggregated_report_request.rb +2 -2
  408. data/lib/factpulse/models/submit_cdar_request.rb +2 -2
  409. data/lib/factpulse/models/submit_cdar_response.rb +2 -2
  410. data/lib/factpulse/models/submit_cdarxml_request.rb +2 -2
  411. data/lib/factpulse/models/submit_complete_invoice_request.rb +2 -2
  412. data/lib/factpulse/models/submit_complete_invoice_response.rb +33 -4
  413. data/lib/factpulse/models/submit_e_reporting_request.rb +2 -2
  414. data/lib/factpulse/models/submit_e_reporting_response.rb +2 -2
  415. data/lib/factpulse/models/submit_flow_request.rb +2 -2
  416. data/lib/factpulse/models/submit_flow_response.rb +2 -2
  417. data/lib/factpulse/models/submit_gross_amount.rb +2 -2
  418. data/lib/factpulse/models/submit_invoice_request.rb +3 -3
  419. data/lib/factpulse/models/submit_invoice_response.rb +2 -2
  420. data/lib/factpulse/models/submit_net_amount.rb +2 -2
  421. data/lib/factpulse/models/submit_vat_amount.rb +2 -2
  422. data/lib/factpulse/models/supplementary_attachment.rb +2 -2
  423. data/lib/factpulse/models/supplier.rb +4 -18
  424. data/lib/factpulse/models/task_error_result.rb +257 -0
  425. data/lib/factpulse/models/task_response.rb +2 -2
  426. data/lib/factpulse/models/tax_breakdown_input.rb +2 -2
  427. data/lib/factpulse/models/tax_due_date_type.rb +2 -2
  428. data/lib/factpulse/models/tax_representative.rb +2 -2
  429. data/lib/factpulse/models/taxable_amount.rb +2 -2
  430. data/lib/factpulse/models/taxableamount.rb +2 -2
  431. data/lib/factpulse/models/taxamount.rb +2 -2
  432. data/lib/factpulse/models/taxamount1.rb +2 -2
  433. data/lib/factpulse/models/taxamount2.rb +2 -2
  434. data/lib/factpulse/models/taxexclusiveamount.rb +2 -2
  435. data/lib/factpulse/models/taxexclusiveamount1.rb +2 -2
  436. data/lib/factpulse/models/total_gross_amount.rb +2 -2
  437. data/lib/factpulse/models/total_net_amount.rb +2 -2
  438. data/lib/factpulse/models/total_vat_amount.rb +2 -2
  439. data/lib/factpulse/models/transaction_category.rb +2 -2
  440. data/lib/factpulse/models/transmission_type_code.rb +2 -2
  441. data/lib/factpulse/models/unit_net_price.rb +2 -2
  442. data/lib/factpulse/models/unit_of_measure.rb +17 -3
  443. data/lib/factpulse/models/validate_cdar_request.rb +2 -2
  444. data/lib/factpulse/models/validate_cdar_response.rb +4 -4
  445. data/lib/factpulse/models/validate_e_reporting_request.rb +2 -2
  446. data/lib/factpulse/models/validate_e_reporting_response.rb +2 -2
  447. data/lib/factpulse/models/validation_error.rb +2 -2
  448. data/lib/factpulse/models/validation_error_detail.rb +2 -2
  449. data/lib/factpulse/models/validation_error_response.rb +22 -69
  450. data/lib/factpulse/models/validation_info.rb +2 -2
  451. data/lib/factpulse/models/validation_success_response.rb +2 -2
  452. data/lib/factpulse/models/validation_success_task_result.rb +210 -0
  453. data/lib/factpulse/models/validation_task_status.rb +223 -0
  454. data/lib/factpulse/models/validation_task_status_result.rb +55 -0
  455. data/lib/factpulse/models/vat_accounting_code.rb +2 -2
  456. data/lib/factpulse/models/vat_amount.rb +2 -2
  457. data/lib/factpulse/models/vat_category.rb +2 -2
  458. data/lib/factpulse/models/vat_line.rb +2 -2
  459. data/lib/factpulse/models/vat_point_date_code.rb +2 -2
  460. data/lib/factpulse/models/vat_rate.rb +2 -2
  461. data/lib/factpulse/models/vatex_code_info.rb +247 -0
  462. data/lib/factpulse/models/vatex_codes_response.rb +204 -0
  463. data/lib/factpulse/models/verification_success_response.rb +2 -2
  464. data/lib/factpulse/models/verification_success_task_result.rb +210 -0
  465. data/lib/factpulse/models/verification_typed_task_status.rb +223 -0
  466. data/lib/factpulse/models/verification_typed_task_status_result.rb +55 -0
  467. data/lib/factpulse/models/verified_field_schema.rb +2 -2
  468. data/lib/factpulse/models/webhook_secret_delete_response.rb +2 -2
  469. data/lib/factpulse/models/webhook_secret_generate_response.rb +2 -2
  470. data/lib/factpulse/models/webhook_secret_status_response.rb +2 -2
  471. data/lib/factpulse/version.rb +3 -3
  472. data/lib/factpulse.rb +57 -24
  473. metadata +167 -101
  474. data/docs/AFNORAddressEdit.md +0 -30
  475. data/docs/AFNORAddressPatch.md +0 -30
  476. data/docs/AFNORAddressPut.md +0 -30
  477. data/docs/AFNORCreateDirectoryLineBody.md +0 -20
  478. data/docs/AFNORCreateDirectoryLineBodyAddressingInformation.md +0 -24
  479. data/docs/AFNORCreateDirectoryLineBodyPeriod.md +0 -20
  480. data/docs/AFNORCreateRoutingCodeBody.md +0 -32
  481. data/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md +0 -20
  482. data/docs/AFNORDirectoryLinePost201Response.md +0 -22
  483. data/docs/AFNORLegalUnitPayloadIncludedNoSiren.md +0 -22
  484. data/docs/AFNORRoutingCodePost201Response.md +0 -22
  485. data/docs/AFNORUpdatePatchDirectoryLineBody.md +0 -18
  486. data/docs/AFNORUpdatePatchRoutingCodeBody.md +0 -24
  487. data/docs/AFNORUpdatePutRoutingCodeBody.md +0 -24
  488. data/docs/AFNORWebhookCallbackContent.md +0 -18
  489. data/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +0 -26
  490. data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +0 -18
  491. data/lib/factpulse/models/afnor_address_edit.rb +0 -353
  492. data/lib/factpulse/models/afnor_address_patch.rb +0 -386
  493. data/lib/factpulse/models/afnor_address_put.rb +0 -435
  494. data/lib/factpulse/models/afnor_create_directory_line_body.rb +0 -156
  495. data/lib/factpulse/models/afnor_create_directory_line_body_addressing_information.rb +0 -294
  496. data/lib/factpulse/models/afnor_create_directory_line_body_period.rb +0 -175
  497. data/lib/factpulse/models/afnor_create_routing_code_body.rb +0 -412
  498. data/lib/factpulse/models/afnor_diffusion_status.rb +0 -40
  499. data/lib/factpulse/models/afnor_directory_line_payload_history_legal_unit_facility_routing_code_platform.rb +0 -178
  500. data/lib/factpulse/models/afnor_directory_line_post201_response.rb +0 -187
  501. data/lib/factpulse/models/afnor_facility_nature.rb +0 -40
  502. data/lib/factpulse/models/afnor_legal_unit_payload_included_no_siren.rb +0 -207
  503. data/lib/factpulse/models/afnor_platform_status.rb +0 -40
  504. data/lib/factpulse/models/afnor_routing_code_post201_response.rb +0 -228
  505. data/lib/factpulse/models/afnor_update_patch_directory_line_body.rb +0 -148
  506. data/lib/factpulse/models/afnor_update_patch_routing_code_body.rb +0 -258
  507. data/lib/factpulse/models/afnor_update_put_routing_code_body.rb +0 -289
  508. data/lib/factpulse/models/afnor_webhook_callback_content.rb +0 -148
  509. data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +0 -259
  510. data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +0 -168
@@ -1,30 +1,30 @@
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
 
13
13
  require 'cgi'
14
14
 
15
15
  module FactPulse
16
- class FacturXGenerationApi
16
+ class InvoiceGenerationApi
17
17
  attr_accessor :api_client
18
18
 
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Generate a Factur-X invoice
23
- # Generates an electronic invoice in Factur-X format compliant with European standards. ## Applied Standards - **Factur-X** (France): FNFE-MPE standard (Forum National de la Facture Électronique) - **ZUGFeRD** (Germany): German format compatible with Factur-X - **EN 16931**: European semantic standard for electronic invoicing - **ISO 19005-3** (PDF/A-3): Long-term electronic archiving - **Cross Industry Invoice (CII)**: UN/CEFACT XML syntax ## 🆕 New: Simplified format with auto-enrichment (P0.1) You can now create an invoice by providing only: - An invoice number - A supplier SIRET + **IBAN** (required) - A recipient SIRET - Invoice lines (description, quantity, net price) **Simplified format example**: ```json { \"number\": \"FACT-2025-001\", \"supplier\": { \"siret\": \"92019522900017\", \"iban\": \"FR7630001007941234567890185\" }, \"recipient\": {\"siret\": \"35600000000048\"}, \"lines\": [ {\"description\": \"Service\", \"quantity\": 10, \"unitPrice\": 100.00, \"vatRate\": 20.0} ] } ``` **⚠️ Required fields (simplified format)**: - `number`: Unique invoice number - `supplier.siret`: Supplier's SIRET (14 digits) - `supplier.iban`: Bank account IBAN (no public API to retrieve it) - `recipient.siret`: Recipient's SIRET - `lines[]`: At least one invoice line **What happens automatically with `auto_enrich=True`**: - ✅ Name enrichment from Chorus Pro API - ✅ Address enrichment from Business Search API (free, public) - ✅ Automatic intra-EU VAT calculation (FR + key + SIREN) - ✅ Chorus Pro ID retrieval for electronic invoicing - ✅ Net/VAT/Gross totals calculation - ✅ Date generation (today + 30-day due date) - ✅ Multi-rate VAT handling **Supported identifiers**: - SIRET (14 digits): Specific establishment ⭐ Recommended - SIREN (9 digits): Company (auto-selection of headquarters) - Special types: UE_HORS_FRANCE, RIDET, TAHITI, etc. ## Checks performed during generation ### 1. Data validation (Pydantic) - Data types (amounts as Decimal, ISO 8601 dates) - Formats (14-digit SIRET, 9-digit SIREN, IBAN) - Required fields per profile - Amount consistency (Net + VAT = Gross) ### 2. CII-compliant XML generation - Serialization according to Cross Industry Invoice XSD schema - Correct UN/CEFACT namespaces - Hierarchical structure respected - UTF-8 encoding without BOM ### 3. Schematron validation - Business rules for selected profile (MINIMUM, BASIC, EN16931, EXTENDED) - Element cardinality (required, optional, repeatable) - Calculation rules (totals, VAT, discounts) - European EN 16931 compliance ### 4. PDF/A-3 conversion (if output_format='pdf') - Source PDF conversion to PDF/A-3 via Ghostscript - Factur-X XML embedding in PDF - Compliant XMP metadata - ICC sRGB color profile - Removal of forbidden elements (JavaScript, forms) ## How it works 1. **Submission**: Invoice is queued in Celery for asynchronous processing 2. **Immediate return**: You receive a `task_id` (HTTP 202 Accepted) 3. **Tracking**: Use the `/tasks/{task_id}/status` endpoint to track progress ## Webhook notification (recommended) Instead of polling, you can receive a webhook notification when the task completes: ``` callback_url=https://your-server.com/webhook ``` The webhook will POST a JSON payload with: - `event_type`: `generation.completed` or `generation.failed` - `data.task_id`: The Celery task ID - `data.content_b64` or `data.xml_content`: The generated content - `X-Webhook-Signature` header for HMAC verification See `/docs/WEBHOOKS.md` for full documentation. ## Output formats - **xml**: Generates only Factur-X XML (recommended for testing) - **pdf**: Generates PDF/A-3 with embedded XML (requires `source_pdf`) ## Factur-X profiles - **MINIMUM**: Minimal data (simplified invoice) - **BASIC**: Basic information (SMEs) - **EN16931**: European standard (recommended, compliant with directive 2014/55/EU) - **EXTENDED**: All available data (large accounts) ## What you get After successful processing (status `completed`): - **XML only**: Base64-encoded Factur-X compliant XML file - **PDF/A-3**: PDF with embedded XML, ready for sending/archiving - **Metadata**: Profile, Factur-X version, file size - **Validation**: Schematron compliance confirmation ## Validation Data is automatically validated according to detected format. On error, a 422 status is returned with invalid field details.
22
+ # Generate an electronic invoice (CII / UBL / Factur-X PDF)
23
+ # Generates an electronic invoice compliant with European standards. Supports **two XML syntaxes** defined by EN 16931: - **CII** (Cross-Industry Invoice, UN/CEFACT) the Factur-X / ZUGFeRD syntax - **UBL 2.1** (Universal Business Language, OASIS) the Peppol BIS Billing syntax ## Applied Standards - **EN 16931**: European semantic standard for electronic invoicing - **Factur-X / ZUGFeRD** (CII syntax): Franco-German standard - **UBL 2.1** (OASIS): International standard, used by Peppol - **ISO 19005-3** (PDF/A-3): Long-term electronic archiving (PDF output only) - **Schematron**: Business rules validation (EN16931-CII, EN16931-UBL, BR-FR) ## 🆕 New: Simplified format with auto-enrichment (P0.1) You can now create an invoice by providing only: - An invoice number - A supplier SIRET + **IBAN** (required) - A recipient SIRET - Invoice lines (description, quantity, net price) **Simplified format example**: ```json { \"number\": \"FACT-2025-001\", \"supplier\": { \"siret\": \"92019522900017\", \"iban\": \"FR7630001007941234567890185\" }, \"recipient\": {\"siret\": \"35600000000048\"}, \"lines\": [ {\"description\": \"Service\", \"quantity\": 10, \"unitPrice\": 100.00, \"vatRate\": 20.0} ] } ``` **⚠️ Required fields (simplified format)**: - `number`: Unique invoice number - `supplier.siret`: Supplier's SIRET (14 digits) - `supplier.iban`: Bank account IBAN (no public API to retrieve it) - `recipient.siret`: Recipient's SIRET - `lines[]`: At least one invoice line **What happens automatically with `auto_enrich=True`**: - ✅ Name enrichment from Chorus Pro API - ✅ Address enrichment from Business Search API (free, public) - ✅ Automatic intra-EU VAT calculation (FR + key + SIREN) - ✅ Chorus Pro ID retrieval for electronic invoicing - ✅ Net/VAT/Gross totals calculation - ✅ Date generation (today + 30-day due date) - ✅ Multi-rate VAT handling **Supported identifiers**: - SIRET (14 digits): Specific establishment ⭐ Recommended - SIREN (9 digits): Company (auto-selection of headquarters) - Special types: UE_HORS_FRANCE, RIDET, TAHITI, etc. ## Checks performed during generation ### 1. Data validation (Pydantic) - Data types (amounts as Decimal, ISO 8601 dates) - Formats (14-digit SIRET, 9-digit SIREN, IBAN) - Required fields per profile - Amount consistency (Net + VAT = Gross) ### 2. CII-compliant XML generation - Serialization according to Cross Industry Invoice XSD schema - Correct UN/CEFACT namespaces - Hierarchical structure respected - UTF-8 encoding without BOM ### 3. Schematron validation - Business rules for selected profile (MINIMUM, BASIC, EN16931, EXTENDED) - Element cardinality (required, optional, repeatable) - Calculation rules (totals, VAT, discounts) - European EN 16931 compliance ### 4. PDF/A-3 conversion (if output_format='pdf') - Source PDF conversion to PDF/A-3 via Ghostscript - Factur-X XML embedding in PDF - Compliant XMP metadata - ICC sRGB color profile - Removal of forbidden elements (JavaScript, forms) ## How it works 1. **Submission**: Invoice is queued in Celery for asynchronous processing 2. **Immediate return**: You receive a `task_id` (HTTP 202 Accepted) 3. **Tracking**: Use the `/tasks/{task_id}/status` endpoint to track progress ## Webhook notification (recommended) Instead of polling, you can receive a webhook notification when the task completes: ``` callback_url=https://your-server.com/webhook ``` The webhook will POST a JSON payload with: - `event_type`: `generation.completed` or `generation.failed` - `data.task_id`: The Celery task ID - `data.content_b64` or `data.xml_content`: The generated content - `X-Webhook-Signature` header for HMAC verification See `/docs/WEBHOOKS.md` for full documentation. ## Output formats - **xml** / **cii**: CII XML (Factur-X syntax, UN/CEFACT) - **ubl**: UBL 2.1 XML (OASIS, Peppol BIS Billing 3.0) - **pdf**: Factur-X PDF/A-3 with embedded CII XML (requires `source_pdf`) ## Factur-X profiles (CII only) - **MINIMUM**: Minimal data (simplified invoice) - **BASIC**: Basic information (SMEs) - **EN16931**: European standard (recommended, compliant with directive 2014/55/EU) - **EXTENDED**: All available data (large accounts) When `output_format=ubl`, the profile parameter is ignored (UBL always uses EN16931). ## What you get After successful processing (status `completed`): - **XML only**: Base64-encoded Factur-X compliant XML file - **PDF/A-3**: PDF with embedded XML, ready for sending/archiving - **Metadata**: Profile, Factur-X version, file size - **Validation**: Schematron compliance confirmation ## Validation Data is automatically validated according to detected format. On error, a 422 status is returned with invalid field details.
24
24
  # @param invoice_data [String] Invoice data in JSON format. Two formats accepted: 1. **Classic format**: Complete FacturXInvoice structure (all fields) 2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment Format is detected automatically!
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [APIProfile] :profile Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED.
27
- # @option opts [OutputFormat] :output_format Output format: 'xml' (XML only) or 'pdf' (Factur-X PDF with embedded XML).
26
+ # @option opts [APIProfile] :profile Factur-X/CII profile: MINIMUM, BASIC, EN16931 or EXTENDED. Ignored when output_format='ubl' (always EN16931).
27
+ # @option opts [OutputFormat] :output_format Output format: 'xml' or 'cii' (CII/Factur-X XML), 'ubl' (UBL 2.1 XML), 'pdf' (Factur-X PDF/A-3).
28
28
  # @option opts [Boolean] :auto_enrich 🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only) (default to true)
29
29
  # @option opts [File] :source_pdf
30
30
  # @option opts [String] :callback_url
@@ -36,12 +36,12 @@ module FactPulse
36
36
  data
37
37
  end
38
38
 
39
- # Generate a Factur-X invoice
40
- # Generates an electronic invoice in Factur-X format compliant with European standards. ## Applied Standards - **Factur-X** (France): FNFE-MPE standard (Forum National de la Facture Électronique) - **ZUGFeRD** (Germany): German format compatible with Factur-X - **EN 16931**: European semantic standard for electronic invoicing - **ISO 19005-3** (PDF/A-3): Long-term electronic archiving - **Cross Industry Invoice (CII)**: UN/CEFACT XML syntax ## 🆕 New: Simplified format with auto-enrichment (P0.1) You can now create an invoice by providing only: - An invoice number - A supplier SIRET + **IBAN** (required) - A recipient SIRET - Invoice lines (description, quantity, net price) **Simplified format example**: ```json { \"number\": \"FACT-2025-001\", \"supplier\": { \"siret\": \"92019522900017\", \"iban\": \"FR7630001007941234567890185\" }, \"recipient\": {\"siret\": \"35600000000048\"}, \"lines\": [ {\"description\": \"Service\", \"quantity\": 10, \"unitPrice\": 100.00, \"vatRate\": 20.0} ] } ``` **⚠️ Required fields (simplified format)**: - `number`: Unique invoice number - `supplier.siret`: Supplier's SIRET (14 digits) - `supplier.iban`: Bank account IBAN (no public API to retrieve it) - `recipient.siret`: Recipient's SIRET - `lines[]`: At least one invoice line **What happens automatically with `auto_enrich=True`**: - ✅ Name enrichment from Chorus Pro API - ✅ Address enrichment from Business Search API (free, public) - ✅ Automatic intra-EU VAT calculation (FR + key + SIREN) - ✅ Chorus Pro ID retrieval for electronic invoicing - ✅ Net/VAT/Gross totals calculation - ✅ Date generation (today + 30-day due date) - ✅ Multi-rate VAT handling **Supported identifiers**: - SIRET (14 digits): Specific establishment ⭐ Recommended - SIREN (9 digits): Company (auto-selection of headquarters) - Special types: UE_HORS_FRANCE, RIDET, TAHITI, etc. ## Checks performed during generation ### 1. Data validation (Pydantic) - Data types (amounts as Decimal, ISO 8601 dates) - Formats (14-digit SIRET, 9-digit SIREN, IBAN) - Required fields per profile - Amount consistency (Net + VAT = Gross) ### 2. CII-compliant XML generation - Serialization according to Cross Industry Invoice XSD schema - Correct UN/CEFACT namespaces - Hierarchical structure respected - UTF-8 encoding without BOM ### 3. Schematron validation - Business rules for selected profile (MINIMUM, BASIC, EN16931, EXTENDED) - Element cardinality (required, optional, repeatable) - Calculation rules (totals, VAT, discounts) - European EN 16931 compliance ### 4. PDF/A-3 conversion (if output_format='pdf') - Source PDF conversion to PDF/A-3 via Ghostscript - Factur-X XML embedding in PDF - Compliant XMP metadata - ICC sRGB color profile - Removal of forbidden elements (JavaScript, forms) ## How it works 1. **Submission**: Invoice is queued in Celery for asynchronous processing 2. **Immediate return**: You receive a `task_id` (HTTP 202 Accepted) 3. **Tracking**: Use the `/tasks/{task_id}/status` endpoint to track progress ## Webhook notification (recommended) Instead of polling, you can receive a webhook notification when the task completes: ``` callback_url=https://your-server.com/webhook ``` The webhook will POST a JSON payload with: - `event_type`: `generation.completed` or `generation.failed` - `data.task_id`: The Celery task ID - `data.content_b64` or `data.xml_content`: The generated content - `X-Webhook-Signature` header for HMAC verification See `/docs/WEBHOOKS.md` for full documentation. ## Output formats - **xml**: Generates only Factur-X XML (recommended for testing) - **pdf**: Generates PDF/A-3 with embedded XML (requires `source_pdf`) ## Factur-X profiles - **MINIMUM**: Minimal data (simplified invoice) - **BASIC**: Basic information (SMEs) - **EN16931**: European standard (recommended, compliant with directive 2014/55/EU) - **EXTENDED**: All available data (large accounts) ## What you get After successful processing (status `completed`): - **XML only**: Base64-encoded Factur-X compliant XML file - **PDF/A-3**: PDF with embedded XML, ready for sending/archiving - **Metadata**: Profile, Factur-X version, file size - **Validation**: Schematron compliance confirmation ## Validation Data is automatically validated according to detected format. On error, a 422 status is returned with invalid field details.
39
+ # Generate an electronic invoice (CII / UBL / Factur-X PDF)
40
+ # Generates an electronic invoice compliant with European standards. Supports **two XML syntaxes** defined by EN 16931: - **CII** (Cross-Industry Invoice, UN/CEFACT) the Factur-X / ZUGFeRD syntax - **UBL 2.1** (Universal Business Language, OASIS) the Peppol BIS Billing syntax ## Applied Standards - **EN 16931**: European semantic standard for electronic invoicing - **Factur-X / ZUGFeRD** (CII syntax): Franco-German standard - **UBL 2.1** (OASIS): International standard, used by Peppol - **ISO 19005-3** (PDF/A-3): Long-term electronic archiving (PDF output only) - **Schematron**: Business rules validation (EN16931-CII, EN16931-UBL, BR-FR) ## 🆕 New: Simplified format with auto-enrichment (P0.1) You can now create an invoice by providing only: - An invoice number - A supplier SIRET + **IBAN** (required) - A recipient SIRET - Invoice lines (description, quantity, net price) **Simplified format example**: ```json { \"number\": \"FACT-2025-001\", \"supplier\": { \"siret\": \"92019522900017\", \"iban\": \"FR7630001007941234567890185\" }, \"recipient\": {\"siret\": \"35600000000048\"}, \"lines\": [ {\"description\": \"Service\", \"quantity\": 10, \"unitPrice\": 100.00, \"vatRate\": 20.0} ] } ``` **⚠️ Required fields (simplified format)**: - `number`: Unique invoice number - `supplier.siret`: Supplier's SIRET (14 digits) - `supplier.iban`: Bank account IBAN (no public API to retrieve it) - `recipient.siret`: Recipient's SIRET - `lines[]`: At least one invoice line **What happens automatically with `auto_enrich=True`**: - ✅ Name enrichment from Chorus Pro API - ✅ Address enrichment from Business Search API (free, public) - ✅ Automatic intra-EU VAT calculation (FR + key + SIREN) - ✅ Chorus Pro ID retrieval for electronic invoicing - ✅ Net/VAT/Gross totals calculation - ✅ Date generation (today + 30-day due date) - ✅ Multi-rate VAT handling **Supported identifiers**: - SIRET (14 digits): Specific establishment ⭐ Recommended - SIREN (9 digits): Company (auto-selection of headquarters) - Special types: UE_HORS_FRANCE, RIDET, TAHITI, etc. ## Checks performed during generation ### 1. Data validation (Pydantic) - Data types (amounts as Decimal, ISO 8601 dates) - Formats (14-digit SIRET, 9-digit SIREN, IBAN) - Required fields per profile - Amount consistency (Net + VAT = Gross) ### 2. CII-compliant XML generation - Serialization according to Cross Industry Invoice XSD schema - Correct UN/CEFACT namespaces - Hierarchical structure respected - UTF-8 encoding without BOM ### 3. Schematron validation - Business rules for selected profile (MINIMUM, BASIC, EN16931, EXTENDED) - Element cardinality (required, optional, repeatable) - Calculation rules (totals, VAT, discounts) - European EN 16931 compliance ### 4. PDF/A-3 conversion (if output_format='pdf') - Source PDF conversion to PDF/A-3 via Ghostscript - Factur-X XML embedding in PDF - Compliant XMP metadata - ICC sRGB color profile - Removal of forbidden elements (JavaScript, forms) ## How it works 1. **Submission**: Invoice is queued in Celery for asynchronous processing 2. **Immediate return**: You receive a `task_id` (HTTP 202 Accepted) 3. **Tracking**: Use the `/tasks/{task_id}/status` endpoint to track progress ## Webhook notification (recommended) Instead of polling, you can receive a webhook notification when the task completes: ``` callback_url=https://your-server.com/webhook ``` The webhook will POST a JSON payload with: - `event_type`: `generation.completed` or `generation.failed` - `data.task_id`: The Celery task ID - `data.content_b64` or `data.xml_content`: The generated content - `X-Webhook-Signature` header for HMAC verification See `/docs/WEBHOOKS.md` for full documentation. ## Output formats - **xml** / **cii**: CII XML (Factur-X syntax, UN/CEFACT) - **ubl**: UBL 2.1 XML (OASIS, Peppol BIS Billing 3.0) - **pdf**: Factur-X PDF/A-3 with embedded CII XML (requires `source_pdf`) ## Factur-X profiles (CII only) - **MINIMUM**: Minimal data (simplified invoice) - **BASIC**: Basic information (SMEs) - **EN16931**: European standard (recommended, compliant with directive 2014/55/EU) - **EXTENDED**: All available data (large accounts) When `output_format=ubl`, the profile parameter is ignored (UBL always uses EN16931). ## What you get After successful processing (status `completed`): - **XML only**: Base64-encoded Factur-X compliant XML file - **PDF/A-3**: PDF with embedded XML, ready for sending/archiving - **Metadata**: Profile, Factur-X version, file size - **Validation**: Schematron compliance confirmation ## Validation Data is automatically validated according to detected format. On error, a 422 status is returned with invalid field details.
41
41
  # @param invoice_data [String] Invoice data in JSON format. Two formats accepted: 1. **Classic format**: Complete FacturXInvoice structure (all fields) 2. **Simplified format** (🆕 P0.1): Minimal structure with auto-enrichment Format is detected automatically!
42
42
  # @param [Hash] opts the optional parameters
43
- # @option opts [APIProfile] :profile Factur-X profile: MINIMUM, BASIC, EN16931 or EXTENDED.
44
- # @option opts [OutputFormat] :output_format Output format: 'xml' (XML only) or 'pdf' (Factur-X PDF with embedded XML).
43
+ # @option opts [APIProfile] :profile Factur-X/CII profile: MINIMUM, BASIC, EN16931 or EXTENDED. Ignored when output_format='ubl' (always EN16931).
44
+ # @option opts [OutputFormat] :output_format Output format: 'xml' or 'cii' (CII/Factur-X XML), 'ubl' (UBL 2.1 XML), 'pdf' (Factur-X PDF/A-3).
45
45
  # @option opts [Boolean] :auto_enrich 🆕 Enable auto-enrichment from SIRET/SIREN (simplified format only) (default to true)
46
46
  # @option opts [File] :source_pdf
47
47
  # @option opts [String] :callback_url
@@ -50,11 +50,11 @@ module FactPulse
50
50
  # @return [Array<(TaskResponse, Integer, Hash)>] TaskResponse data, response status code and response headers
51
51
  def generate_invoice_api_v1_processing_generate_invoice_post_with_http_info(invoice_data, opts = {})
52
52
  if @api_client.config.debugging
53
- @api_client.config.logger.debug 'Calling API: FacturXGenerationApi.generate_invoice_api_v1_processing_generate_invoice_post ...'
53
+ @api_client.config.logger.debug 'Calling API: InvoiceGenerationApi.generate_invoice_api_v1_processing_generate_invoice_post ...'
54
54
  end
55
55
  # verify the required parameter 'invoice_data' is set
56
56
  if @api_client.config.client_side_validation && invoice_data.nil?
57
- fail ArgumentError, "Missing the required parameter 'invoice_data' when calling FacturXGenerationApi.generate_invoice_api_v1_processing_generate_invoice_post"
57
+ fail ArgumentError, "Missing the required parameter 'invoice_data' when calling InvoiceGenerationApi.generate_invoice_api_v1_processing_generate_invoice_post"
58
58
  end
59
59
  # resource path
60
60
  local_var_path = '/api/v1/processing/generate-invoice'
@@ -93,7 +93,7 @@ module FactPulse
93
93
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
94
94
 
95
95
  new_options = opts.merge(
96
- :operation => :"FacturXGenerationApi.generate_invoice_api_v1_processing_generate_invoice_post",
96
+ :operation => :"InvoiceGenerationApi.generate_invoice_api_v1_processing_generate_invoice_post",
97
97
  :header_params => header_params,
98
98
  :query_params => query_params,
99
99
  :form_params => form_params,
@@ -104,7 +104,7 @@ module FactPulse
104
104
 
105
105
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
106
106
  if @api_client.config.debugging
107
- @api_client.config.logger.debug "API called: FacturXGenerationApi#generate_invoice_api_v1_processing_generate_invoice_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
107
+ @api_client.config.logger.debug "API called: InvoiceGenerationApi#generate_invoice_api_v1_processing_generate_invoice_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
108
108
  end
109
109
  return data, status_code, headers
110
110
  end
@@ -126,11 +126,11 @@ module FactPulse
126
126
  # @return [Array<(SubmitCompleteInvoiceResponse, Integer, Hash)>] SubmitCompleteInvoiceResponse data, response status code and response headers
127
127
  def submit_complete_invoice_api_v1_processing_invoices_submit_complete_post_with_http_info(submit_complete_invoice_request, opts = {})
128
128
  if @api_client.config.debugging
129
- @api_client.config.logger.debug 'Calling API: FacturXGenerationApi.submit_complete_invoice_api_v1_processing_invoices_submit_complete_post ...'
129
+ @api_client.config.logger.debug 'Calling API: InvoiceGenerationApi.submit_complete_invoice_api_v1_processing_invoices_submit_complete_post ...'
130
130
  end
131
131
  # verify the required parameter 'submit_complete_invoice_request' is set
132
132
  if @api_client.config.client_side_validation && submit_complete_invoice_request.nil?
133
- fail ArgumentError, "Missing the required parameter 'submit_complete_invoice_request' when calling FacturXGenerationApi.submit_complete_invoice_api_v1_processing_invoices_submit_complete_post"
133
+ fail ArgumentError, "Missing the required parameter 'submit_complete_invoice_request' when calling InvoiceGenerationApi.submit_complete_invoice_api_v1_processing_invoices_submit_complete_post"
134
134
  end
135
135
  # resource path
136
136
  local_var_path = '/api/v1/processing/invoices/submit-complete'
@@ -161,7 +161,7 @@ module FactPulse
161
161
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
162
162
 
163
163
  new_options = opts.merge(
164
- :operation => :"FacturXGenerationApi.submit_complete_invoice_api_v1_processing_invoices_submit_complete_post",
164
+ :operation => :"InvoiceGenerationApi.submit_complete_invoice_api_v1_processing_invoices_submit_complete_post",
165
165
  :header_params => header_params,
166
166
  :query_params => query_params,
167
167
  :form_params => form_params,
@@ -172,7 +172,7 @@ module FactPulse
172
172
 
173
173
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
174
174
  if @api_client.config.debugging
175
- @api_client.config.logger.debug "API called: FacturXGenerationApi#submit_complete_invoice_api_v1_processing_invoices_submit_complete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
175
+ @api_client.config.logger.debug "API called: InvoiceGenerationApi#submit_complete_invoice_api_v1_processing_invoices_submit_complete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
176
176
  end
177
177
  return data, status_code, headers
178
178
  end
@@ -198,11 +198,11 @@ module FactPulse
198
198
  # @return [Array<(TaskResponse, Integer, Hash)>] TaskResponse data, response status code and response headers
199
199
  def submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post_with_http_info(submit_complete_invoice_request, opts = {})
200
200
  if @api_client.config.debugging
201
- @api_client.config.logger.debug 'Calling API: FacturXGenerationApi.submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post ...'
201
+ @api_client.config.logger.debug 'Calling API: InvoiceGenerationApi.submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post ...'
202
202
  end
203
203
  # verify the required parameter 'submit_complete_invoice_request' is set
204
204
  if @api_client.config.client_side_validation && submit_complete_invoice_request.nil?
205
- fail ArgumentError, "Missing the required parameter 'submit_complete_invoice_request' when calling FacturXGenerationApi.submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post"
205
+ fail ArgumentError, "Missing the required parameter 'submit_complete_invoice_request' when calling InvoiceGenerationApi.submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post"
206
206
  end
207
207
  # resource path
208
208
  local_var_path = '/api/v1/processing/invoices/submit-complete-async'
@@ -235,7 +235,7 @@ module FactPulse
235
235
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
236
236
 
237
237
  new_options = opts.merge(
238
- :operation => :"FacturXGenerationApi.submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post",
238
+ :operation => :"InvoiceGenerationApi.submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post",
239
239
  :header_params => header_params,
240
240
  :query_params => query_params,
241
241
  :form_params => form_params,
@@ -246,7 +246,7 @@ module FactPulse
246
246
 
247
247
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
248
248
  if @api_client.config.debugging
249
- @api_client.config.logger.debug "API called: FacturXGenerationApi#submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
249
+ @api_client.config.logger.debug "API called: InvoiceGenerationApi#submit_complete_invoice_async_api_v1_processing_invoices_submit_complete_async_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
250
250
  end
251
251
  return data, status_code, headers
252
252
  end
@@ -0,0 +1,163 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
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
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: contact@factpulse.fr
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.21.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module FactPulse
16
+ class ParseApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Parse Factur-X XML or PDF (async)
23
+ # Parse a Factur-X file asynchronously using a Celery task. **Use case:** For large files or when you want non-blocking processing. **Workflow:** 1. Submit file with this endpoint -> receive `task_id` 2. Poll `/tasks/{task_id}/status` for result 3. Result contains `invoice` and `detected_profile` **Optional:** Provide `callback_url` to receive a webhook when parsing completes.
24
+ # @param file [File] Factur-X PDF or XML file to parse
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :callback_url
27
+ # @return [TaskResponse]
28
+ def parse_facturx_async_api_v1_processing_parse_facturx_async_post(file, opts = {})
29
+ data, _status_code, _headers = parse_facturx_async_api_v1_processing_parse_facturx_async_post_with_http_info(file, opts)
30
+ data
31
+ end
32
+
33
+ # Parse Factur-X XML or PDF (async)
34
+ # Parse a Factur-X file asynchronously using a Celery task. **Use case:** For large files or when you want non-blocking processing. **Workflow:** 1. Submit file with this endpoint -&gt; receive &#x60;task_id&#x60; 2. Poll &#x60;/tasks/{task_id}/status&#x60; for result 3. Result contains &#x60;invoice&#x60; and &#x60;detected_profile&#x60; **Optional:** Provide &#x60;callback_url&#x60; to receive a webhook when parsing completes.
35
+ # @param file [File] Factur-X PDF or XML file to parse
36
+ # @param [Hash] opts the optional parameters
37
+ # @option opts [String] :callback_url
38
+ # @return [Array<(TaskResponse, Integer, Hash)>] TaskResponse data, response status code and response headers
39
+ def parse_facturx_async_api_v1_processing_parse_facturx_async_post_with_http_info(file, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: ParseApi.parse_facturx_async_api_v1_processing_parse_facturx_async_post ...'
42
+ end
43
+ # verify the required parameter 'file' is set
44
+ if @api_client.config.client_side_validation && file.nil?
45
+ fail ArgumentError, "Missing the required parameter 'file' when calling ParseApi.parse_facturx_async_api_v1_processing_parse_facturx_async_post"
46
+ end
47
+ # resource path
48
+ local_var_path = '/api/v1/processing/parse-facturx/async'
49
+
50
+ # query parameters
51
+ query_params = opts[:query_params] || {}
52
+
53
+ # header parameters
54
+ header_params = opts[:header_params] || {}
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
57
+ # HTTP header 'Content-Type'
58
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
59
+ if !content_type.nil?
60
+ header_params['Content-Type'] = content_type
61
+ end
62
+
63
+ # form parameters
64
+ form_params = opts[:form_params] || {}
65
+ form_params['file'] = file
66
+ form_params['callbackUrl'] = opts[:'callback_url'] if !opts[:'callback_url'].nil?
67
+
68
+ # http body (model)
69
+ post_body = opts[:debug_body]
70
+
71
+ # return_type
72
+ return_type = opts[:debug_return_type] || 'TaskResponse'
73
+
74
+ # auth_names
75
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
76
+
77
+ new_options = opts.merge(
78
+ :operation => :"ParseApi.parse_facturx_async_api_v1_processing_parse_facturx_async_post",
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => return_type
85
+ )
86
+
87
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug "API called: ParseApi#parse_facturx_async_api_v1_processing_parse_facturx_async_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
90
+ end
91
+ return data, status_code, headers
92
+ end
93
+
94
+ # Parse CII, UBL or Factur-X PDF (sync)
95
+ # Parse a CII XML, UBL XML, or Factur-X PDF and extract the invoice data as a FacturXInvoice model. **Use cases:** - Extract invoice data from received invoices (any format) - Round-trip: parse an existing invoice, modify it, and regenerate in another format - Convert between CII and UBL via the FacturXInvoice pivot model **Supported formats:** - Factur-X PDF (PDF/A-3 with embedded CII XML) - CII XML (UN/CEFACT Cross-Industry Invoice) - UBL 2.1 XML (OASIS Invoice or CreditNote) **Returns:** - `invoice`: Complete FacturXInvoice data (can be used with /generate-invoice) - `detected_profile`: Factur-X profile (MINIMUM, BASIC, EN16931, EXTENDED)
96
+ # @param file [File] Factur-X PDF or XML file to parse
97
+ # @param [Hash] opts the optional parameters
98
+ # @return [ParseFacturXResponse]
99
+ def parse_facturx_sync_api_v1_processing_parse_facturx_post(file, opts = {})
100
+ data, _status_code, _headers = parse_facturx_sync_api_v1_processing_parse_facturx_post_with_http_info(file, opts)
101
+ data
102
+ end
103
+
104
+ # Parse CII, UBL or Factur-X PDF (sync)
105
+ # Parse a CII XML, UBL XML, or Factur-X PDF and extract the invoice data as a FacturXInvoice model. **Use cases:** - Extract invoice data from received invoices (any format) - Round-trip: parse an existing invoice, modify it, and regenerate in another format - Convert between CII and UBL via the FacturXInvoice pivot model **Supported formats:** - Factur-X PDF (PDF/A-3 with embedded CII XML) - CII XML (UN/CEFACT Cross-Industry Invoice) - UBL 2.1 XML (OASIS Invoice or CreditNote) **Returns:** - &#x60;invoice&#x60;: Complete FacturXInvoice data (can be used with /generate-invoice) - &#x60;detected_profile&#x60;: Factur-X profile (MINIMUM, BASIC, EN16931, EXTENDED)
106
+ # @param file [File] Factur-X PDF or XML file to parse
107
+ # @param [Hash] opts the optional parameters
108
+ # @return [Array<(ParseFacturXResponse, Integer, Hash)>] ParseFacturXResponse data, response status code and response headers
109
+ def parse_facturx_sync_api_v1_processing_parse_facturx_post_with_http_info(file, opts = {})
110
+ if @api_client.config.debugging
111
+ @api_client.config.logger.debug 'Calling API: ParseApi.parse_facturx_sync_api_v1_processing_parse_facturx_post ...'
112
+ end
113
+ # verify the required parameter 'file' is set
114
+ if @api_client.config.client_side_validation && file.nil?
115
+ fail ArgumentError, "Missing the required parameter 'file' when calling ParseApi.parse_facturx_sync_api_v1_processing_parse_facturx_post"
116
+ end
117
+ # resource path
118
+ local_var_path = '/api/v1/processing/parse-facturx'
119
+
120
+ # query parameters
121
+ query_params = opts[:query_params] || {}
122
+
123
+ # header parameters
124
+ header_params = opts[:header_params] || {}
125
+ # HTTP header 'Accept' (if needed)
126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
127
+ # HTTP header 'Content-Type'
128
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
129
+ if !content_type.nil?
130
+ header_params['Content-Type'] = content_type
131
+ end
132
+
133
+ # form parameters
134
+ form_params = opts[:form_params] || {}
135
+ form_params['file'] = file
136
+
137
+ # http body (model)
138
+ post_body = opts[:debug_body]
139
+
140
+ # return_type
141
+ return_type = opts[:debug_return_type] || 'ParseFacturXResponse'
142
+
143
+ # auth_names
144
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
145
+
146
+ new_options = opts.merge(
147
+ :operation => :"ParseApi.parse_facturx_sync_api_v1_processing_parse_facturx_post",
148
+ :header_params => header_params,
149
+ :query_params => query_params,
150
+ :form_params => form_params,
151
+ :body => post_body,
152
+ :auth_names => auth_names,
153
+ :return_type => return_type
154
+ )
155
+
156
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
157
+ if @api_client.config.debugging
158
+ @api_client.config.logger.debug "API called: ParseApi#parse_facturx_sync_api_v1_processing_parse_facturx_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
159
+ end
160
+ return data, status_code, headers
161
+ end
162
+ end
163
+ end
@@ -0,0 +1,82 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
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
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: contact@factpulse.fr
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.21.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module FactPulse
16
+ class ReferencesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # VATEX exemption reason codes
23
+ # Returns the list of VATEX (VAT exemption reason) codes from the Peppol BIS Billing 3.0 code list. Source: https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [String] :category Filter by VAT category code (E, AE, K, G, O).
26
+ # @return [VATEXCodesResponse]
27
+ def get_vatex_codes_api_v1_references_vatex_codes_get(opts = {})
28
+ data, _status_code, _headers = get_vatex_codes_api_v1_references_vatex_codes_get_with_http_info(opts)
29
+ data
30
+ end
31
+
32
+ # VATEX exemption reason codes
33
+ # Returns the list of VATEX (VAT exemption reason) codes from the Peppol BIS Billing 3.0 code list. Source: https://docs.peppol.eu/poacc/billing/3.0/codelist/vatex/
34
+ # @param [Hash] opts the optional parameters
35
+ # @option opts [String] :category Filter by VAT category code (E, AE, K, G, O).
36
+ # @return [Array<(VATEXCodesResponse, Integer, Hash)>] VATEXCodesResponse data, response status code and response headers
37
+ def get_vatex_codes_api_v1_references_vatex_codes_get_with_http_info(opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: ReferencesApi.get_vatex_codes_api_v1_references_vatex_codes_get ...'
40
+ end
41
+ # resource path
42
+ local_var_path = '/api/v1/references/vatex-codes'
43
+
44
+ # query parameters
45
+ query_params = opts[:query_params] || {}
46
+ query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
47
+
48
+ # header parameters
49
+ header_params = opts[:header_params] || {}
50
+ # HTTP header 'Accept' (if needed)
51
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
52
+
53
+ # form parameters
54
+ form_params = opts[:form_params] || {}
55
+
56
+ # http body (model)
57
+ post_body = opts[:debug_body]
58
+
59
+ # return_type
60
+ return_type = opts[:debug_return_type] || 'VATEXCodesResponse'
61
+
62
+ # auth_names
63
+ auth_names = opts[:debug_auth_names] || []
64
+
65
+ new_options = opts.merge(
66
+ :operation => :"ReferencesApi.get_vatex_codes_api_v1_references_vatex_codes_get",
67
+ :header_params => header_params,
68
+ :query_params => query_params,
69
+ :form_params => form_params,
70
+ :body => post_body,
71
+ :auth_names => auth_names,
72
+ :return_type => return_type
73
+ )
74
+
75
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: ReferencesApi#get_vatex_codes_api_v1_references_vatex_codes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,97 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
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
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: contact@factpulse.fr
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.21.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module FactPulse
16
+ class ValidationApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Validate a CII or UBL XML against Schematron rules
23
+ # Validates a CII (Factur-X) or UBL XML file against Schematron business rules. The XML format is **auto-detected** from namespace: - CII XML → validated with EN16931-CII + profile-specific + BR-FR-CII Schematrons - UBL XML → validated with EN16931-UBL + BR-FR-UBL Schematrons ## 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 rules (BR-FR-CII or BR-FR-UBL) - Arithmetic calculations and data consistency ## Profiles and validated rules (CII only) ### 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
24
+ # @param xml_file [File] CII (Factur-X) or UBL XML file to validate (.xml format). Format is auto-detected.
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [APIProfile] :profile Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). Used for CII only; ignored for UBL (always EN16931).
27
+ # @option opts [Boolean] :skip_br_fr
28
+ # @return [ValidationSuccessResponse]
29
+ def validate_xml_api_v1_processing_validate_xml_post(xml_file, opts = {})
30
+ data, _status_code, _headers = validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts)
31
+ data
32
+ end
33
+
34
+ # Validate a CII or UBL XML against Schematron rules
35
+ # Validates a CII (Factur-X) or UBL XML file against Schematron business rules. The XML format is **auto-detected** from namespace: - CII XML → validated with EN16931-CII + profile-specific + BR-FR-CII Schematrons - UBL XML → validated with EN16931-UBL + BR-FR-UBL Schematrons ## 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 rules (BR-FR-CII or BR-FR-UBL) - Arithmetic calculations and data consistency ## Profiles and validated rules (CII only) ### 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
36
+ # @param xml_file [File] CII (Factur-X) or UBL XML file to validate (.xml format). Format is auto-detected.
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [APIProfile] :profile Validation profile (MINIMUM, BASIC, EN16931, EXTENDED). Used for CII only; ignored for UBL (always EN16931).
39
+ # @option opts [Boolean] :skip_br_fr
40
+ # @return [Array<(ValidationSuccessResponse, Integer, Hash)>] ValidationSuccessResponse data, response status code and response headers
41
+ def validate_xml_api_v1_processing_validate_xml_post_with_http_info(xml_file, opts = {})
42
+ if @api_client.config.debugging
43
+ @api_client.config.logger.debug 'Calling API: ValidationApi.validate_xml_api_v1_processing_validate_xml_post ...'
44
+ end
45
+ # verify the required parameter 'xml_file' is set
46
+ if @api_client.config.client_side_validation && xml_file.nil?
47
+ fail ArgumentError, "Missing the required parameter 'xml_file' when calling ValidationApi.validate_xml_api_v1_processing_validate_xml_post"
48
+ end
49
+ # resource path
50
+ local_var_path = '/api/v1/processing/validate-xml'
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+
55
+ # header parameters
56
+ header_params = opts[:header_params] || {}
57
+ # HTTP header 'Accept' (if needed)
58
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
59
+ # HTTP header 'Content-Type'
60
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
61
+ if !content_type.nil?
62
+ header_params['Content-Type'] = content_type
63
+ end
64
+
65
+ # form parameters
66
+ form_params = opts[:form_params] || {}
67
+ form_params['xml_file'] = xml_file
68
+ form_params['profile'] = opts[:'profile'] if !opts[:'profile'].nil?
69
+ form_params['skip_br_fr'] = opts[:'skip_br_fr'] if !opts[:'skip_br_fr'].nil?
70
+
71
+ # http body (model)
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type] || 'ValidationSuccessResponse'
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['APIKeyHeader', 'HTTPBearer']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"ValidationApi.validate_xml_api_v1_processing_validate_xml_post",
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: ValidationApi#validate_xml_api_v1_processing_validate_xml_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+ end
97
+ end