factpulse 2.0.42 → 3.0.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -3
- data/Gemfile.lock +3 -3
- data/README.md +91 -91
- data/docs/{CredentialsAFNOR.md → AFNORCredentials.md} +2 -2
- data/docs/{DestinationAFNOR.md → AFNORDestination.md} +4 -4
- data/docs/AFNORHealthCheckResponse.md +22 -0
- data/docs/AFNORPDPPAApi.md +25 -25
- data/docs/AFNORPDPPADirectoryServiceApi.md +19 -19
- data/docs/AFNORPDPPAFlowServiceApi.md +16 -16
- data/docs/{ResultatAFNOR.md → AFNORResult.md} +5 -5
- data/docs/APIError.md +2 -2
- data/docs/{MontantTva.md → APIProfile.md} +2 -2
- data/docs/{CodeCadreFacturation.md → AcknowledgmentStatus.md} +2 -2
- data/docs/{CodeRaisonReduction.md → AllowanceReasonCode.md} +2 -2
- data/docs/{ModeDepot.md → AmountDue.md} +2 -2
- data/docs/BoundingBoxSchema.md +7 -7
- data/docs/{CategorieTVA.md → CeleryStatus.md} +2 -2
- data/docs/CertificateInfoResponse.md +20 -20
- data/docs/ChorusProApi.md +123 -123
- data/docs/ChorusProDestination.md +20 -0
- data/docs/ChorusProResult.md +22 -0
- data/docs/Destination.md +7 -7
- data/docs/{ModePaiement.md → DocumentType.md} +2 -2
- data/docs/{AdresseElectronique.md → ElectronicAddress.md} +4 -4
- data/docs/EnrichedInvoiceInfo.md +32 -0
- data/docs/FacturXPDFInfo.md +22 -0
- data/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +26 -0
- data/docs/{CredentialsChorusPro.md → FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md} +4 -4
- data/docs/FactureFacturX.md +30 -30
- data/docs/FieldStatus.md +15 -0
- data/docs/{DirectionFlux.md → FlowDirection.md} +2 -2
- data/docs/FlowProfile.md +15 -0
- data/docs/FlowSummary.md +32 -0
- data/docs/{ProfilFlux.md → FlowSyntax.md} +2 -2
- data/docs/{TypeTVA.md → FlowType.md} +2 -2
- data/docs/GenerateCertificateRequest.md +19 -19
- data/docs/GenerateCertificateResponse.md +8 -8
- data/docs/GetChorusProIdRequest.md +22 -0
- data/docs/GetChorusProIdResponse.md +24 -0
- data/docs/GetInvoiceRequest.md +20 -0
- data/docs/GetInvoiceResponse.md +34 -0
- data/docs/GetStructureRequest.md +22 -0
- data/docs/GetStructureResponse.md +34 -0
- data/docs/GlobalAllowanceAmount.md +15 -0
- data/docs/{SantApi.md → HealthApi.md} +23 -23
- data/docs/IncomingInvoice.md +54 -0
- data/docs/IncomingSupplier.md +32 -0
- data/docs/{FormatFacture.md → InvoiceFormat.md} +2 -2
- data/docs/InvoiceLine.md +46 -0
- data/docs/InvoiceLineAllowanceAmount.md +15 -0
- data/docs/InvoiceNote.md +20 -0
- data/docs/InvoiceProcessingApi.md +831 -0
- data/docs/InvoiceReferences.md +32 -0
- data/docs/{StatutFacture.md → InvoiceStatus.md} +5 -5
- data/docs/InvoiceTotals.md +30 -0
- data/docs/InvoiceTotalsPrepayment.md +15 -0
- data/docs/InvoiceTypeCode.md +15 -0
- data/docs/InvoicingFramework.md +24 -0
- data/docs/InvoicingFrameworkCode.md +15 -0
- data/docs/LineNetAmount.md +15 -0
- data/docs/MandatoryNoteSchema.md +30 -0
- data/docs/ManualRate.md +15 -0
- data/docs/ManualVatRate.md +15 -0
- data/docs/OperationNature.md +15 -0
- data/docs/{FormatSortie.md → OutputFormat.md} +2 -2
- data/docs/PDFValidationResultAPI.md +62 -0
- data/docs/PDFXMLVerificationApi.md +435 -0
- data/docs/PDPCredentials.md +4 -4
- data/docs/PageDimensionsSchema.md +20 -0
- data/docs/{Beneficiaire.md → Payee.md} +5 -5
- data/docs/PaymentMeans.md +15 -0
- data/docs/PostalAddress.md +26 -0
- data/docs/ProcessingOptions.md +24 -0
- data/docs/{Quantite.md → Quantity.md} +2 -2
- data/docs/Recipient.md +28 -0
- data/docs/SearchFlowRequest.md +34 -0
- data/docs/SearchFlowResponse.md +24 -0
- data/docs/SearchServicesResponse.md +24 -0
- data/docs/SearchStructureRequest.md +26 -0
- data/docs/SearchStructureResponse.md +24 -0
- data/docs/SignatureInfo.md +2 -2
- data/docs/SignatureInfoAPI.md +28 -0
- data/docs/SignatureParameters.md +34 -0
- data/docs/SimplifiedInvoiceData.md +34 -0
- data/docs/StructureInfo.md +10 -10
- data/docs/StructureParameters.md +22 -0
- data/docs/StructureService.md +24 -0
- data/docs/SubmissionMode.md +15 -0
- data/docs/SubmitCompleteInvoiceRequest.md +26 -0
- data/docs/SubmitCompleteInvoiceResponse.md +34 -0
- data/docs/SubmitFlowRequest.md +28 -0
- data/docs/SubmitFlowResponse.md +30 -0
- data/docs/SubmitInvoiceRequest.md +46 -0
- data/docs/SubmitInvoiceResponse.md +24 -0
- data/docs/SupplementaryAttachment.md +26 -0
- data/docs/Supplier.md +36 -0
- data/docs/TaskResponse.md +18 -0
- data/docs/TaskStatus.md +22 -0
- data/docs/TaxableAmount.md +15 -0
- data/docs/TotalGrossAmount.md +15 -0
- data/docs/TotalNetAmount.md +15 -0
- data/docs/TotalVATAmount.md +15 -0
- data/docs/UnitNetPrice.md +15 -0
- data/docs/UnitOfMeasure.md +15 -0
- data/docs/UserApi.md +74 -0
- data/docs/VATAccountingCode.md +15 -0
- data/docs/{ProfilAPI.md → VATAmount.md} +2 -2
- data/docs/VATCategory.md +15 -0
- data/docs/VATLine.md +30 -0
- data/docs/ValidationErrorDetail.md +3 -3
- data/docs/ValidationErrorResponse.md +18 -0
- data/docs/ValidationSuccessResponse.md +18 -0
- data/docs/{TypeFlux.md → VatAmount.md} +2 -2
- data/docs/VerificationSuccessResponse.md +36 -0
- data/docs/VerifiedFieldSchema.md +34 -0
- data/factpulse.gemspec +4 -4
- data/lib/factpulse/api/afnorpdppa_api.rb +25 -25
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +40 -40
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +16 -16
- data/lib/factpulse/api/chorus_pro_api.rb +127 -127
- data/lib/factpulse/api/health_api.rb +136 -0
- data/lib/factpulse/api/invoice_processing_api.rb +835 -0
- data/lib/factpulse/api/pdfxml_verification_api.rb +430 -0
- data/lib/factpulse/api/user_api.rb +79 -0
- data/lib/factpulse/api_client.rb +2 -2
- data/lib/factpulse/api_error.rb +2 -2
- data/lib/factpulse/api_model_base.rb +2 -2
- data/lib/factpulse/configuration.rb +2 -2
- data/lib/factpulse/helpers/client.rb +182 -182
- data/lib/factpulse/helpers/exceptions.rb +2 -2
- data/lib/factpulse/helpers/helpers.rb +5 -5
- data/lib/factpulse/models/acknowledgment_status.rb +41 -0
- data/lib/factpulse/models/afnor_credentials.rb +169 -0
- data/lib/factpulse/models/{destination_afnor.rb → afnor_destination.rb} +10 -10
- data/lib/factpulse/models/{reponse_healthcheck_afnor.rb → afnor_health_check_response.rb} +9 -9
- data/lib/factpulse/models/{resultat_afnor.rb → afnor_result.rb} +13 -13
- data/lib/factpulse/models/allowance_reason_code.rb +45 -0
- data/lib/factpulse/models/amount_due.rb +104 -0
- data/lib/factpulse/models/api_error.rb +5 -5
- data/lib/factpulse/models/api_profile.rb +42 -0
- data/lib/factpulse/models/bounding_box_schema.rb +10 -10
- data/lib/factpulse/models/celery_status.rb +43 -0
- data/lib/factpulse/models/certificate_info_response.rb +164 -164
- data/lib/factpulse/models/{destination_chorus_pro.rb → chorus_pro_destination.rb} +7 -7
- data/lib/factpulse/models/chorus_pro_result.rb +186 -0
- data/lib/factpulse/models/destination.rb +7 -7
- data/lib/factpulse/models/document_type.rb +43 -0
- data/lib/factpulse/models/electronic_address.rb +196 -0
- data/lib/factpulse/models/enriched_invoice_info.rb +348 -0
- data/lib/factpulse/models/error_level.rb +2 -2
- data/lib/factpulse/models/error_source.rb +2 -2
- data/lib/factpulse/models/factur_xpdf_info.rb +205 -0
- data/lib/factpulse/models/{chorus_pro_credentials.rb → facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb} +11 -11
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb +191 -0
- data/lib/factpulse/models/facture_factur_x.rb +160 -160
- data/lib/factpulse/models/field_status.rb +43 -0
- data/lib/factpulse/models/flow_direction.rb +40 -0
- data/lib/factpulse/models/flow_profile.rb +41 -0
- data/lib/factpulse/models/flow_summary.rb +251 -0
- data/lib/factpulse/models/flow_syntax.rb +43 -0
- data/lib/factpulse/models/flow_type.rb +43 -0
- data/lib/factpulse/models/generate_certificate_request.rb +106 -106
- data/lib/factpulse/models/generate_certificate_response.rb +47 -47
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +188 -0
- data/lib/factpulse/models/get_chorus_pro_id_response.rb +230 -0
- data/lib/factpulse/models/get_invoice_request.rb +176 -0
- data/lib/factpulse/models/get_invoice_response.rb +261 -0
- data/lib/factpulse/models/get_structure_request.rb +188 -0
- data/lib/factpulse/models/get_structure_response.rb +261 -0
- data/lib/factpulse/models/global_allowance_amount.rb +104 -0
- data/lib/factpulse/models/http_validation_error.rb +2 -2
- data/lib/factpulse/models/incoming_invoice.rb +522 -0
- data/lib/factpulse/models/incoming_supplier.rb +236 -0
- data/lib/factpulse/models/invoice_format.rb +41 -0
- data/lib/factpulse/models/invoice_line.rb +389 -0
- data/lib/factpulse/models/invoice_line_allowance_amount.rb +104 -0
- data/lib/factpulse/models/invoice_note.rb +175 -0
- data/lib/factpulse/models/invoice_references.rb +290 -0
- data/lib/factpulse/models/invoice_status.rb +203 -0
- data/lib/factpulse/models/invoice_totals.rb +272 -0
- data/lib/factpulse/models/invoice_totals_prepayment.rb +104 -0
- data/lib/factpulse/models/invoice_type_code.rb +70 -0
- data/lib/factpulse/models/invoicing_framework.rb +217 -0
- data/lib/factpulse/models/invoicing_framework_code.rb +46 -0
- data/lib/factpulse/models/line_net_amount.rb +104 -0
- data/lib/factpulse/models/mandatory_note_schema.rb +265 -0
- data/lib/factpulse/models/manual_rate.rb +104 -0
- data/lib/factpulse/models/manual_vat_rate.rb +104 -0
- data/lib/factpulse/models/operation_nature.rb +52 -0
- data/lib/factpulse/models/output_format.rb +40 -0
- data/lib/factpulse/models/page_dimensions_schema.rb +193 -0
- data/lib/factpulse/models/{beneficiaire.rb → payee.rb} +15 -15
- data/lib/factpulse/models/payment_means.rb +50 -0
- data/lib/factpulse/models/pdf_validation_result_api.rb +523 -0
- data/lib/factpulse/models/pdp_credentials.rb +7 -7
- data/lib/factpulse/models/postal_address.rb +189 -0
- data/lib/factpulse/models/processing_options.rb +207 -0
- data/lib/factpulse/models/quantity.rb +104 -0
- data/lib/factpulse/models/recipient.rb +201 -0
- data/lib/factpulse/models/scheme_id.rb +2 -2
- data/lib/factpulse/models/search_flow_request.rb +306 -0
- data/lib/factpulse/models/search_flow_response.rb +249 -0
- data/lib/factpulse/models/search_services_response.rb +214 -0
- data/lib/factpulse/models/search_structure_request.rb +191 -0
- data/lib/factpulse/models/search_structure_response.rb +216 -0
- data/lib/factpulse/models/signature_info.rb +20 -20
- data/lib/factpulse/models/signature_info_api.rb +216 -0
- data/lib/factpulse/models/signature_parameters.rb +235 -0
- data/lib/factpulse/models/simplified_invoice_data.rb +342 -0
- data/lib/factpulse/models/structure_info.rb +84 -84
- data/lib/factpulse/models/structure_parameters.rb +175 -0
- data/lib/factpulse/models/structure_service.rb +247 -0
- data/lib/factpulse/models/submission_mode.rb +44 -0
- data/lib/factpulse/models/submit_complete_invoice_request.rb +239 -0
- data/lib/factpulse/models/submit_complete_invoice_response.rb +355 -0
- data/lib/factpulse/models/submit_flow_request.rb +238 -0
- data/lib/factpulse/models/submit_flow_response.rb +294 -0
- data/lib/factpulse/models/submit_invoice_request.rb +388 -0
- data/lib/factpulse/models/submit_invoice_response.rb +213 -0
- data/lib/factpulse/models/supplementary_attachment.rb +269 -0
- data/lib/factpulse/models/supplier.rb +257 -0
- data/lib/factpulse/models/task_response.rb +166 -0
- data/lib/factpulse/models/task_status.rb +227 -0
- data/lib/factpulse/models/taxable_amount.rb +104 -0
- data/lib/factpulse/models/total_gross_amount.rb +104 -0
- data/lib/factpulse/models/total_net_amount.rb +104 -0
- data/lib/factpulse/models/total_vat_amount.rb +104 -0
- data/lib/factpulse/models/unit_net_price.rb +104 -0
- data/lib/factpulse/models/unit_of_measure.rb +50 -0
- data/lib/factpulse/models/validation_error.rb +2 -2
- data/lib/factpulse/models/validation_error_detail.rb +6 -6
- data/lib/factpulse/models/validation_error_loc_inner.rb +2 -2
- data/lib/factpulse/models/validation_error_response.rb +168 -0
- data/lib/factpulse/models/validation_success_response.rb +166 -0
- data/lib/factpulse/models/vat_accounting_code.rb +46 -0
- data/lib/factpulse/models/vat_amount.rb +104 -0
- data/lib/factpulse/models/vat_category.rb +47 -0
- data/lib/factpulse/models/vat_line.rb +262 -0
- data/lib/factpulse/models/verification_success_response.rb +343 -0
- data/lib/factpulse/models/verified_field_schema.rb +334 -0
- data/lib/factpulse/version.rb +3 -3
- data/lib/factpulse.rb +99 -99
- metadata +250 -257
- data/docs/AdressePostale.md +0 -26
- data/docs/CadreDeFacturation.md +0 -24
- data/docs/ChampVerifieSchema.md +0 -34
- data/docs/ChorusProCredentials.md +0 -26
- data/docs/ConsulterFactureRequest.md +0 -20
- data/docs/ConsulterFactureResponse.md +0 -34
- data/docs/ConsulterStructureRequest.md +0 -22
- data/docs/ConsulterStructureResponse.md +0 -34
- data/docs/Destinataire.md +0 -28
- data/docs/DestinationChorusPro.md +0 -20
- data/docs/DimensionPageSchema.md +0 -20
- data/docs/DonneesFactureSimplifiees.md +0 -34
- data/docs/FactureEnrichieInfo.md +0 -32
- data/docs/FactureEntrante.md +0 -54
- data/docs/FluxResume.md +0 -32
- data/docs/Fournisseur.md +0 -36
- data/docs/FournisseurEntrant.md +0 -32
- data/docs/InformationSignatureAPI.md +0 -28
- data/docs/LigneDePoste.md +0 -46
- data/docs/LigneDePosteMontantRemiseHt.md +0 -15
- data/docs/LigneDePosteTauxTvaManuel.md +0 -15
- data/docs/LigneDeTVA.md +0 -30
- data/docs/MontantAPayer.md +0 -15
- data/docs/MontantBaseHt.md +0 -15
- data/docs/MontantHtTotal.md +0 -15
- data/docs/MontantRemiseGlobaleTtc.md +0 -15
- data/docs/MontantTotal.md +0 -30
- data/docs/MontantTotalAcompte.md +0 -15
- data/docs/MontantTotalLigneHt.md +0 -15
- data/docs/MontantTtcTotal.md +0 -15
- data/docs/MontantTvaLigne.md +0 -15
- data/docs/MontantTvaTotal.md +0 -15
- data/docs/MontantUnitaireHt.md +0 -15
- data/docs/NatureOperation.md +0 -15
- data/docs/Note.md +0 -20
- data/docs/NoteObligatoireSchema.md +0 -30
- data/docs/ObtenirIdChorusProRequest.md +0 -22
- data/docs/ObtenirIdChorusProResponse.md +0 -24
- data/docs/OptionsProcessing.md +0 -24
- data/docs/PDFFacturXInfo.md +0 -22
- data/docs/ParametresSignature.md +0 -34
- data/docs/ParametresStructure.md +0 -22
- data/docs/PieceJointeComplementaire.md +0 -26
- data/docs/RechercherServicesResponse.md +0 -24
- data/docs/RechercherStructureRequest.md +0 -26
- data/docs/RechercherStructureResponse.md +0 -24
- data/docs/References.md +0 -32
- data/docs/ReponseHealthcheckAFNOR.md +0 -22
- data/docs/ReponseRechercheFlux.md +0 -24
- data/docs/ReponseSoumissionFlux.md +0 -30
- data/docs/ReponseTache.md +0 -18
- data/docs/ReponseValidationErreur.md +0 -18
- data/docs/ReponseValidationSucces.md +0 -18
- data/docs/ReponseVerificationSucces.md +0 -36
- data/docs/RequeteRechercheFlux.md +0 -34
- data/docs/RequeteSoumissionFlux.md +0 -28
- data/docs/ResultatChorusPro.md +0 -22
- data/docs/ResultatValidationPDFAPI.md +0 -62
- data/docs/ServiceStructure.md +0 -24
- data/docs/SoumettreFactureCompleteRequest.md +0 -26
- data/docs/SoumettreFactureCompleteResponse.md +0 -34
- data/docs/SoumettreFactureRequest.md +0 -46
- data/docs/SoumettreFactureResponse.md +0 -24
- data/docs/StatutAcquittement.md +0 -15
- data/docs/StatutCelery.md +0 -15
- data/docs/StatutChampAPI.md +0 -15
- data/docs/StatutTache.md +0 -22
- data/docs/SyntaxeFlux.md +0 -15
- data/docs/Tauxmanuel.md +0 -15
- data/docs/TraitementFactureApi.md +0 -831
- data/docs/TypeDocument.md +0 -15
- data/docs/TypeFacture.md +0 -15
- data/docs/Unite.md +0 -15
- data/docs/UtilisateurApi.md +0 -74
- data/docs/VrificationPDFXMLApi.md +0 -435
- data/lib/factpulse/api/sant_api.rb +0 -136
- data/lib/factpulse/api/traitement_facture_api.rb +0 -835
- data/lib/factpulse/api/utilisateur_api.rb +0 -79
- data/lib/factpulse/api/vrification_pdfxml_api.rb +0 -430
- data/lib/factpulse/models/adresse_electronique.rb +0 -196
- data/lib/factpulse/models/adresse_postale.rb +0 -189
- data/lib/factpulse/models/cadre_de_facturation.rb +0 -217
- data/lib/factpulse/models/categorie_tva.rb +0 -47
- data/lib/factpulse/models/champ_verifie_schema.rb +0 -334
- data/lib/factpulse/models/code_cadre_facturation.rb +0 -42
- data/lib/factpulse/models/code_raison_reduction.rb +0 -45
- data/lib/factpulse/models/consulter_facture_request.rb +0 -176
- data/lib/factpulse/models/consulter_facture_response.rb +0 -261
- data/lib/factpulse/models/consulter_structure_request.rb +0 -188
- data/lib/factpulse/models/consulter_structure_response.rb +0 -261
- data/lib/factpulse/models/credentials_afnor.rb +0 -169
- data/lib/factpulse/models/credentials_chorus_pro.rb +0 -191
- data/lib/factpulse/models/destinataire.rb +0 -201
- data/lib/factpulse/models/dimension_page_schema.rb +0 -193
- data/lib/factpulse/models/direction_flux.rb +0 -40
- data/lib/factpulse/models/donnees_facture_simplifiees.rb +0 -342
- data/lib/factpulse/models/facture_enrichie_info.rb +0 -348
- data/lib/factpulse/models/facture_entrante.rb +0 -522
- data/lib/factpulse/models/flux_resume.rb +0 -251
- data/lib/factpulse/models/format_facture.rb +0 -41
- data/lib/factpulse/models/format_sortie.rb +0 -40
- data/lib/factpulse/models/fournisseur.rb +0 -257
- data/lib/factpulse/models/fournisseur_entrant.rb +0 -236
- data/lib/factpulse/models/information_signature_api.rb +0 -216
- data/lib/factpulse/models/ligne_de_poste.rb +0 -390
- data/lib/factpulse/models/ligne_de_poste_montant_remise_ht.rb +0 -104
- data/lib/factpulse/models/ligne_de_poste_taux_tva_manuel.rb +0 -104
- data/lib/factpulse/models/ligne_de_tva.rb +0 -262
- data/lib/factpulse/models/mode_depot.rb +0 -41
- data/lib/factpulse/models/mode_paiement.rb +0 -44
- data/lib/factpulse/models/montant_a_payer.rb +0 -104
- data/lib/factpulse/models/montant_base_ht.rb +0 -104
- data/lib/factpulse/models/montant_ht_total.rb +0 -104
- data/lib/factpulse/models/montant_remise_globale_ttc.rb +0 -104
- data/lib/factpulse/models/montant_total.rb +0 -272
- data/lib/factpulse/models/montant_total_acompte.rb +0 -104
- data/lib/factpulse/models/montant_total_ligne_ht.rb +0 -104
- data/lib/factpulse/models/montant_ttc_total.rb +0 -104
- data/lib/factpulse/models/montant_tva.rb +0 -104
- data/lib/factpulse/models/montant_tva_ligne.rb +0 -104
- data/lib/factpulse/models/montant_tva_total.rb +0 -104
- data/lib/factpulse/models/montant_unitaire_ht.rb +0 -104
- data/lib/factpulse/models/nature_operation.rb +0 -52
- data/lib/factpulse/models/note.rb +0 -175
- data/lib/factpulse/models/note_obligatoire_schema.rb +0 -265
- data/lib/factpulse/models/obtenir_id_chorus_pro_request.rb +0 -188
- data/lib/factpulse/models/obtenir_id_chorus_pro_response.rb +0 -230
- data/lib/factpulse/models/options_processing.rb +0 -207
- data/lib/factpulse/models/parametres_signature.rb +0 -235
- data/lib/factpulse/models/parametres_structure.rb +0 -175
- data/lib/factpulse/models/pdf_factur_x_info.rb +0 -205
- data/lib/factpulse/models/piece_jointe_complementaire.rb +0 -269
- data/lib/factpulse/models/profil_api.rb +0 -42
- data/lib/factpulse/models/profil_flux.rb +0 -41
- data/lib/factpulse/models/quantite.rb +0 -104
- data/lib/factpulse/models/rechercher_services_response.rb +0 -214
- data/lib/factpulse/models/rechercher_structure_request.rb +0 -191
- data/lib/factpulse/models/rechercher_structure_response.rb +0 -216
- data/lib/factpulse/models/references.rb +0 -290
- data/lib/factpulse/models/reponse_recherche_flux.rb +0 -249
- data/lib/factpulse/models/reponse_soumission_flux.rb +0 -294
- data/lib/factpulse/models/reponse_tache.rb +0 -165
- data/lib/factpulse/models/reponse_validation_erreur.rb +0 -167
- data/lib/factpulse/models/reponse_validation_succes.rb +0 -165
- data/lib/factpulse/models/reponse_verification_succes.rb +0 -343
- data/lib/factpulse/models/requete_recherche_flux.rb +0 -306
- data/lib/factpulse/models/requete_soumission_flux.rb +0 -238
- data/lib/factpulse/models/resultat_chorus_pro.rb +0 -186
- data/lib/factpulse/models/resultat_validation_pdfapi.rb +0 -523
- data/lib/factpulse/models/service_structure.rb +0 -247
- data/lib/factpulse/models/soumettre_facture_complete_request.rb +0 -239
- data/lib/factpulse/models/soumettre_facture_complete_response.rb +0 -355
- data/lib/factpulse/models/soumettre_facture_request.rb +0 -388
- data/lib/factpulse/models/soumettre_facture_response.rb +0 -213
- data/lib/factpulse/models/statut_acquittement.rb +0 -41
- data/lib/factpulse/models/statut_celery.rb +0 -43
- data/lib/factpulse/models/statut_champ_api.rb +0 -43
- data/lib/factpulse/models/statut_facture.rb +0 -203
- data/lib/factpulse/models/statut_tache.rb +0 -226
- data/lib/factpulse/models/syntaxe_flux.rb +0 -43
- data/lib/factpulse/models/tauxmanuel.rb +0 -104
- data/lib/factpulse/models/type_document.rb +0 -43
- data/lib/factpulse/models/type_facture.rb +0 -54
- data/lib/factpulse/models/type_flux.rb +0 -43
- data/lib/factpulse/models/type_tva.rb +0 -42
- data/lib/factpulse/models/unite.rb +0 -44
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#FactPulse REST API
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
|
|
@@ -20,7 +20,7 @@ module FactPulse
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Creating a directory line
|
|
23
|
-
#
|
|
23
|
+
# Create a line in the directory
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
25
|
# @return [Object]
|
|
26
26
|
def create_directory_line_proxy_api_v1_afnor_directory_v1_directory_line_post(opts = {})
|
|
@@ -29,7 +29,7 @@ module FactPulse
|
|
|
29
29
|
end
|
|
30
30
|
|
|
31
31
|
# Creating a directory line
|
|
32
|
-
#
|
|
32
|
+
# Create a line in the directory
|
|
33
33
|
# @param [Hash] opts the optional parameters
|
|
34
34
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
35
35
|
def create_directory_line_proxy_api_v1_afnor_directory_v1_directory_line_post_with_http_info(opts = {})
|
|
@@ -77,7 +77,7 @@ module FactPulse
|
|
|
77
77
|
end
|
|
78
78
|
|
|
79
79
|
# Create a routing code
|
|
80
|
-
#
|
|
80
|
+
# Create a routing code in the directory
|
|
81
81
|
# @param [Hash] opts the optional parameters
|
|
82
82
|
# @return [Object]
|
|
83
83
|
def create_routing_code_proxy_api_v1_afnor_directory_v1_routing_code_post(opts = {})
|
|
@@ -86,7 +86,7 @@ module FactPulse
|
|
|
86
86
|
end
|
|
87
87
|
|
|
88
88
|
# Create a routing code
|
|
89
|
-
#
|
|
89
|
+
# Create a routing code in the directory
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
91
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
92
92
|
def create_routing_code_proxy_api_v1_afnor_directory_v1_routing_code_post_with_http_info(opts = {})
|
|
@@ -134,7 +134,7 @@ module FactPulse
|
|
|
134
134
|
end
|
|
135
135
|
|
|
136
136
|
# Delete a directory line
|
|
137
|
-
#
|
|
137
|
+
# Delete a directory line
|
|
138
138
|
# @param id_instance [String]
|
|
139
139
|
# @param [Hash] opts the optional parameters
|
|
140
140
|
# @return [Object]
|
|
@@ -144,7 +144,7 @@ module FactPulse
|
|
|
144
144
|
end
|
|
145
145
|
|
|
146
146
|
# Delete a directory line
|
|
147
|
-
#
|
|
147
|
+
# Delete a directory line
|
|
148
148
|
# @param id_instance [String]
|
|
149
149
|
# @param [Hash] opts the optional parameters
|
|
150
150
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -197,7 +197,7 @@ module FactPulse
|
|
|
197
197
|
end
|
|
198
198
|
|
|
199
199
|
# Healthcheck Directory Service
|
|
200
|
-
#
|
|
200
|
+
# Check Directory Service availability
|
|
201
201
|
# @param [Hash] opts the optional parameters
|
|
202
202
|
# @return [Object]
|
|
203
203
|
def directory_healthcheck_proxy_api_v1_afnor_directory_v1_healthcheck_get(opts = {})
|
|
@@ -206,7 +206,7 @@ module FactPulse
|
|
|
206
206
|
end
|
|
207
207
|
|
|
208
208
|
# Healthcheck Directory Service
|
|
209
|
-
#
|
|
209
|
+
# Check Directory Service availability
|
|
210
210
|
# @param [Hash] opts the optional parameters
|
|
211
211
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
212
212
|
def directory_healthcheck_proxy_api_v1_afnor_directory_v1_healthcheck_get_with_http_info(opts = {})
|
|
@@ -254,7 +254,7 @@ module FactPulse
|
|
|
254
254
|
end
|
|
255
255
|
|
|
256
256
|
# Get a directory line
|
|
257
|
-
#
|
|
257
|
+
# Get a directory line identified by an addressing identifier
|
|
258
258
|
# @param addressing_identifier [String]
|
|
259
259
|
# @param [Hash] opts the optional parameters
|
|
260
260
|
# @return [Object]
|
|
@@ -264,7 +264,7 @@ module FactPulse
|
|
|
264
264
|
end
|
|
265
265
|
|
|
266
266
|
# Get a directory line
|
|
267
|
-
#
|
|
267
|
+
# Get a directory line identified by an addressing identifier
|
|
268
268
|
# @param addressing_identifier [String]
|
|
269
269
|
# @param [Hash] opts the optional parameters
|
|
270
270
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -317,7 +317,7 @@ module FactPulse
|
|
|
317
317
|
end
|
|
318
318
|
|
|
319
319
|
# Get a directory line
|
|
320
|
-
#
|
|
320
|
+
# Get a directory line identified by its idInstance
|
|
321
321
|
# @param id_instance [String]
|
|
322
322
|
# @param [Hash] opts the optional parameters
|
|
323
323
|
# @return [Object]
|
|
@@ -327,7 +327,7 @@ module FactPulse
|
|
|
327
327
|
end
|
|
328
328
|
|
|
329
329
|
# Get a directory line
|
|
330
|
-
#
|
|
330
|
+
# Get a directory line identified by its idInstance
|
|
331
331
|
# @param id_instance [String]
|
|
332
332
|
# @param [Hash] opts the optional parameters
|
|
333
333
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -380,7 +380,7 @@ module FactPulse
|
|
|
380
380
|
end
|
|
381
381
|
|
|
382
382
|
# Get a routing code by instance-id
|
|
383
|
-
#
|
|
383
|
+
# Get a routing code identified by its idInstance
|
|
384
384
|
# @param id_instance [String]
|
|
385
385
|
# @param [Hash] opts the optional parameters
|
|
386
386
|
# @return [Object]
|
|
@@ -390,7 +390,7 @@ module FactPulse
|
|
|
390
390
|
end
|
|
391
391
|
|
|
392
392
|
# Get a routing code by instance-id
|
|
393
|
-
#
|
|
393
|
+
# Get a routing code identified by its idInstance
|
|
394
394
|
# @param id_instance [String]
|
|
395
395
|
# @param [Hash] opts the optional parameters
|
|
396
396
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -443,7 +443,7 @@ module FactPulse
|
|
|
443
443
|
end
|
|
444
444
|
|
|
445
445
|
# Get a routing code by SIRET and routing identifier
|
|
446
|
-
#
|
|
446
|
+
# Consult a routing code identified by SIRET and routing identifier
|
|
447
447
|
# @param siret [String]
|
|
448
448
|
# @param routing_identifier [String]
|
|
449
449
|
# @param [Hash] opts the optional parameters
|
|
@@ -454,7 +454,7 @@ module FactPulse
|
|
|
454
454
|
end
|
|
455
455
|
|
|
456
456
|
# Get a routing code by SIRET and routing identifier
|
|
457
|
-
#
|
|
457
|
+
# Consult a routing code identified by SIRET and routing identifier
|
|
458
458
|
# @param siret [String]
|
|
459
459
|
# @param routing_identifier [String]
|
|
460
460
|
# @param [Hash] opts the optional parameters
|
|
@@ -512,7 +512,7 @@ module FactPulse
|
|
|
512
512
|
end
|
|
513
513
|
|
|
514
514
|
# Consult a siren (legal unit) by SIREN number
|
|
515
|
-
#
|
|
515
|
+
# Returns details of a company (legal unit) identified by its SIREN number
|
|
516
516
|
# @param siren [String]
|
|
517
517
|
# @param [Hash] opts the optional parameters
|
|
518
518
|
# @return [Object]
|
|
@@ -522,7 +522,7 @@ module FactPulse
|
|
|
522
522
|
end
|
|
523
523
|
|
|
524
524
|
# Consult a siren (legal unit) by SIREN number
|
|
525
|
-
#
|
|
525
|
+
# Returns details of a company (legal unit) identified by its SIREN number
|
|
526
526
|
# @param siren [String]
|
|
527
527
|
# @param [Hash] opts the optional parameters
|
|
528
528
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -575,7 +575,7 @@ module FactPulse
|
|
|
575
575
|
end
|
|
576
576
|
|
|
577
577
|
# Gets a siren (legal unit) by instance ID
|
|
578
|
-
#
|
|
578
|
+
# Get a company (legal unit) identified by its idInstance
|
|
579
579
|
# @param id_instance [String]
|
|
580
580
|
# @param [Hash] opts the optional parameters
|
|
581
581
|
# @return [Object]
|
|
@@ -585,7 +585,7 @@ module FactPulse
|
|
|
585
585
|
end
|
|
586
586
|
|
|
587
587
|
# Gets a siren (legal unit) by instance ID
|
|
588
|
-
#
|
|
588
|
+
# Get a company (legal unit) identified by its idInstance
|
|
589
589
|
# @param id_instance [String]
|
|
590
590
|
# @param [Hash] opts the optional parameters
|
|
591
591
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -638,7 +638,7 @@ module FactPulse
|
|
|
638
638
|
end
|
|
639
639
|
|
|
640
640
|
# Gets a siret (facility) by SIRET number
|
|
641
|
-
#
|
|
641
|
+
# Get an establishment identified by its SIRET number
|
|
642
642
|
# @param siret [String]
|
|
643
643
|
# @param [Hash] opts the optional parameters
|
|
644
644
|
# @return [Object]
|
|
@@ -648,7 +648,7 @@ module FactPulse
|
|
|
648
648
|
end
|
|
649
649
|
|
|
650
650
|
# Gets a siret (facility) by SIRET number
|
|
651
|
-
#
|
|
651
|
+
# Get an establishment identified by its SIRET number
|
|
652
652
|
# @param siret [String]
|
|
653
653
|
# @param [Hash] opts the optional parameters
|
|
654
654
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -701,7 +701,7 @@ module FactPulse
|
|
|
701
701
|
end
|
|
702
702
|
|
|
703
703
|
# Gets a siret (facility) by id-instance
|
|
704
|
-
#
|
|
704
|
+
# Get an establishment identified by its idInstance
|
|
705
705
|
# @param id_instance [String]
|
|
706
706
|
# @param [Hash] opts the optional parameters
|
|
707
707
|
# @return [Object]
|
|
@@ -711,7 +711,7 @@ module FactPulse
|
|
|
711
711
|
end
|
|
712
712
|
|
|
713
713
|
# Gets a siret (facility) by id-instance
|
|
714
|
-
#
|
|
714
|
+
# Get an establishment identified by its idInstance
|
|
715
715
|
# @param id_instance [String]
|
|
716
716
|
# @param [Hash] opts the optional parameters
|
|
717
717
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -764,7 +764,7 @@ module FactPulse
|
|
|
764
764
|
end
|
|
765
765
|
|
|
766
766
|
# Partially updates a directory line
|
|
767
|
-
#
|
|
767
|
+
# Partially update a directory line
|
|
768
768
|
# @param id_instance [String]
|
|
769
769
|
# @param [Hash] opts the optional parameters
|
|
770
770
|
# @return [Object]
|
|
@@ -774,7 +774,7 @@ module FactPulse
|
|
|
774
774
|
end
|
|
775
775
|
|
|
776
776
|
# Partially updates a directory line
|
|
777
|
-
#
|
|
777
|
+
# Partially update a directory line
|
|
778
778
|
# @param id_instance [String]
|
|
779
779
|
# @param [Hash] opts the optional parameters
|
|
780
780
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -827,7 +827,7 @@ module FactPulse
|
|
|
827
827
|
end
|
|
828
828
|
|
|
829
829
|
# Partially update a private routing code
|
|
830
|
-
#
|
|
830
|
+
# Partially update a private routing code
|
|
831
831
|
# @param id_instance [String]
|
|
832
832
|
# @param [Hash] opts the optional parameters
|
|
833
833
|
# @return [Object]
|
|
@@ -837,7 +837,7 @@ module FactPulse
|
|
|
837
837
|
end
|
|
838
838
|
|
|
839
839
|
# Partially update a private routing code
|
|
840
|
-
#
|
|
840
|
+
# Partially update a private routing code
|
|
841
841
|
# @param id_instance [String]
|
|
842
842
|
# @param [Hash] opts the optional parameters
|
|
843
843
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -890,7 +890,7 @@ module FactPulse
|
|
|
890
890
|
end
|
|
891
891
|
|
|
892
892
|
# Completely update a private routing code
|
|
893
|
-
#
|
|
893
|
+
# Completely update a private routing code
|
|
894
894
|
# @param id_instance [String]
|
|
895
895
|
# @param [Hash] opts the optional parameters
|
|
896
896
|
# @return [Object]
|
|
@@ -900,7 +900,7 @@ module FactPulse
|
|
|
900
900
|
end
|
|
901
901
|
|
|
902
902
|
# Completely update a private routing code
|
|
903
|
-
#
|
|
903
|
+
# Completely update a private routing code
|
|
904
904
|
# @param id_instance [String]
|
|
905
905
|
# @param [Hash] opts the optional parameters
|
|
906
906
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -953,7 +953,7 @@ module FactPulse
|
|
|
953
953
|
end
|
|
954
954
|
|
|
955
955
|
# Search for a directory line
|
|
956
|
-
#
|
|
956
|
+
# Search for directory lines by criteria
|
|
957
957
|
# @param [Hash] opts the optional parameters
|
|
958
958
|
# @return [Object]
|
|
959
959
|
def search_directory_line_proxy_api_v1_afnor_directory_v1_directory_line_search_post(opts = {})
|
|
@@ -962,7 +962,7 @@ module FactPulse
|
|
|
962
962
|
end
|
|
963
963
|
|
|
964
964
|
# Search for a directory line
|
|
965
|
-
#
|
|
965
|
+
# Search for directory lines by criteria
|
|
966
966
|
# @param [Hash] opts the optional parameters
|
|
967
967
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
968
968
|
def search_directory_line_proxy_api_v1_afnor_directory_v1_directory_line_search_post_with_http_info(opts = {})
|
|
@@ -1010,7 +1010,7 @@ module FactPulse
|
|
|
1010
1010
|
end
|
|
1011
1011
|
|
|
1012
1012
|
# Search for a routing code
|
|
1013
|
-
#
|
|
1013
|
+
# Search for routing codes by criteria
|
|
1014
1014
|
# @param [Hash] opts the optional parameters
|
|
1015
1015
|
# @return [Object]
|
|
1016
1016
|
def search_routing_code_proxy_api_v1_afnor_directory_v1_routing_code_search_post(opts = {})
|
|
@@ -1019,7 +1019,7 @@ module FactPulse
|
|
|
1019
1019
|
end
|
|
1020
1020
|
|
|
1021
1021
|
# Search for a routing code
|
|
1022
|
-
#
|
|
1022
|
+
# Search for routing codes by criteria
|
|
1023
1023
|
# @param [Hash] opts the optional parameters
|
|
1024
1024
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
1025
1025
|
def search_routing_code_proxy_api_v1_afnor_directory_v1_routing_code_search_post_with_http_info(opts = {})
|
|
@@ -1067,7 +1067,7 @@ module FactPulse
|
|
|
1067
1067
|
end
|
|
1068
1068
|
|
|
1069
1069
|
# SIREN search (or legal unit)
|
|
1070
|
-
#
|
|
1070
|
+
# Multi-criteria search for companies (legal units)
|
|
1071
1071
|
# @param [Hash] opts the optional parameters
|
|
1072
1072
|
# @return [Object]
|
|
1073
1073
|
def search_siren_proxy_api_v1_afnor_directory_v1_siren_search_post(opts = {})
|
|
@@ -1076,7 +1076,7 @@ module FactPulse
|
|
|
1076
1076
|
end
|
|
1077
1077
|
|
|
1078
1078
|
# SIREN search (or legal unit)
|
|
1079
|
-
#
|
|
1079
|
+
# Multi-criteria search for companies (legal units)
|
|
1080
1080
|
# @param [Hash] opts the optional parameters
|
|
1081
1081
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
1082
1082
|
def search_siren_proxy_api_v1_afnor_directory_v1_siren_search_post_with_http_info(opts = {})
|
|
@@ -1124,7 +1124,7 @@ module FactPulse
|
|
|
1124
1124
|
end
|
|
1125
1125
|
|
|
1126
1126
|
# Search for a SIRET (facility)
|
|
1127
|
-
#
|
|
1127
|
+
# Multi-criteria search for establishments
|
|
1128
1128
|
# @param [Hash] opts the optional parameters
|
|
1129
1129
|
# @return [Object]
|
|
1130
1130
|
def search_siret_proxy_api_v1_afnor_directory_v1_siret_search_post(opts = {})
|
|
@@ -1133,7 +1133,7 @@ module FactPulse
|
|
|
1133
1133
|
end
|
|
1134
1134
|
|
|
1135
1135
|
# Search for a SIRET (facility)
|
|
1136
|
-
#
|
|
1136
|
+
# Multi-criteria search for establishments
|
|
1137
1137
|
# @param [Hash] opts the optional parameters
|
|
1138
1138
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
1139
1139
|
def search_siret_proxy_api_v1_afnor_directory_v1_siret_search_post_with_http_info(opts = {})
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#FactPulse REST API
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://www.factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://www.factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://www.factpulse.fr/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://www.factpulse.fr/documentation-api/
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
|
|
@@ -19,8 +19,8 @@ module FactPulse
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
#
|
|
23
|
-
#
|
|
22
|
+
# Download a flow
|
|
23
|
+
# Download the PDF/A-3 file of an invoicing flow (uses JWT client_uid)
|
|
24
24
|
# @param flow_id [String]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [Object]
|
|
@@ -29,8 +29,8 @@ module FactPulse
|
|
|
29
29
|
data
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
#
|
|
33
|
-
#
|
|
32
|
+
# Download a flow
|
|
33
|
+
# Download the PDF/A-3 file of an invoicing flow (uses JWT client_uid)
|
|
34
34
|
# @param flow_id [String]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -83,7 +83,7 @@ module FactPulse
|
|
|
83
83
|
end
|
|
84
84
|
|
|
85
85
|
# Healthcheck Flow Service
|
|
86
|
-
#
|
|
86
|
+
# Check Flow Service availability
|
|
87
87
|
# @param [Hash] opts the optional parameters
|
|
88
88
|
# @return [Object]
|
|
89
89
|
def flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get(opts = {})
|
|
@@ -92,7 +92,7 @@ module FactPulse
|
|
|
92
92
|
end
|
|
93
93
|
|
|
94
94
|
# Healthcheck Flow Service
|
|
95
|
-
#
|
|
95
|
+
# Check Flow Service availability
|
|
96
96
|
# @param [Hash] opts the optional parameters
|
|
97
97
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
98
98
|
def flow_healthcheck_proxy_api_v1_afnor_flow_v1_healthcheck_get_with_http_info(opts = {})
|
|
@@ -139,8 +139,8 @@ module FactPulse
|
|
|
139
139
|
return data, status_code, headers
|
|
140
140
|
end
|
|
141
141
|
|
|
142
|
-
#
|
|
143
|
-
#
|
|
142
|
+
# Search flows
|
|
143
|
+
# Search invoicing flows by criteria (uses JWT client_uid)
|
|
144
144
|
# @param [Hash] opts the optional parameters
|
|
145
145
|
# @return [Object]
|
|
146
146
|
def search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post(opts = {})
|
|
@@ -148,8 +148,8 @@ module FactPulse
|
|
|
148
148
|
data
|
|
149
149
|
end
|
|
150
150
|
|
|
151
|
-
#
|
|
152
|
-
#
|
|
151
|
+
# Search flows
|
|
152
|
+
# Search invoicing flows by criteria (uses JWT client_uid)
|
|
153
153
|
# @param [Hash] opts the optional parameters
|
|
154
154
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
155
155
|
def search_flows_proxy_api_v1_afnor_flow_v1_flows_search_post_with_http_info(opts = {})
|
|
@@ -196,8 +196,8 @@ module FactPulse
|
|
|
196
196
|
return data, status_code, headers
|
|
197
197
|
end
|
|
198
198
|
|
|
199
|
-
#
|
|
200
|
-
#
|
|
199
|
+
# Submit an invoicing flow
|
|
200
|
+
# Submits an electronic invoice to a Partner Dematerialization Platform (PDP) in compliance with the AFNOR XP Z12-013 standard
|
|
201
201
|
# @param [Hash] opts the optional parameters
|
|
202
202
|
# @return [Object]
|
|
203
203
|
def submit_flow_proxy_api_v1_afnor_flow_v1_flows_post(opts = {})
|
|
@@ -205,8 +205,8 @@ module FactPulse
|
|
|
205
205
|
data
|
|
206
206
|
end
|
|
207
207
|
|
|
208
|
-
#
|
|
209
|
-
#
|
|
208
|
+
# Submit an invoicing flow
|
|
209
|
+
# Submits an electronic invoice to a Partner Dematerialization Platform (PDP) in compliance with the AFNOR XP Z12-013 standard
|
|
210
210
|
# @param [Hash] opts the optional parameters
|
|
211
211
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
212
212
|
def submit_flow_proxy_api_v1_afnor_flow_v1_flows_post_with_http_info(opts = {})
|