factpulse 2.0.42 → 3.0.1
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
|
|
|
@@ -14,58 +14,58 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FactPulse
|
|
17
|
-
#
|
|
17
|
+
# Information about a generated certificate.
|
|
18
18
|
class CertificateInfoResponse < ApiModelBase
|
|
19
19
|
# Common Name
|
|
20
20
|
attr_accessor :cn
|
|
21
21
|
|
|
22
|
-
#
|
|
23
|
-
attr_accessor :
|
|
22
|
+
# Organization
|
|
23
|
+
attr_accessor :organization
|
|
24
24
|
|
|
25
|
-
#
|
|
26
|
-
attr_accessor :
|
|
25
|
+
# Country code
|
|
26
|
+
attr_accessor :country
|
|
27
27
|
|
|
28
|
-
#
|
|
29
|
-
attr_accessor :
|
|
28
|
+
# City
|
|
29
|
+
attr_accessor :city
|
|
30
30
|
|
|
31
|
-
# Province
|
|
32
|
-
attr_accessor :
|
|
31
|
+
# State/Province
|
|
32
|
+
attr_accessor :state
|
|
33
33
|
|
|
34
34
|
attr_accessor :email
|
|
35
35
|
|
|
36
|
-
#
|
|
37
|
-
attr_accessor :
|
|
36
|
+
# Full subject (RFC4514)
|
|
37
|
+
attr_accessor :subject
|
|
38
38
|
|
|
39
|
-
#
|
|
40
|
-
attr_accessor :
|
|
39
|
+
# Issuer (self-signed = same as subject)
|
|
40
|
+
attr_accessor :issuer
|
|
41
41
|
|
|
42
|
-
#
|
|
43
|
-
attr_accessor :
|
|
42
|
+
# Certificate serial number
|
|
43
|
+
attr_accessor :serial_number
|
|
44
44
|
|
|
45
|
-
#
|
|
46
|
-
attr_accessor :
|
|
45
|
+
# Validity start date (ISO 8601)
|
|
46
|
+
attr_accessor :valid_from
|
|
47
47
|
|
|
48
|
-
#
|
|
49
|
-
attr_accessor :
|
|
48
|
+
# Validity end date (ISO 8601)
|
|
49
|
+
attr_accessor :valid_to
|
|
50
50
|
|
|
51
|
-
#
|
|
52
|
-
attr_accessor :
|
|
51
|
+
# Signature algorithm
|
|
52
|
+
attr_accessor :algorithm
|
|
53
53
|
|
|
54
54
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
55
55
|
def self.attribute_map
|
|
56
56
|
{
|
|
57
57
|
:'cn' => :'cn',
|
|
58
|
-
:'
|
|
59
|
-
:'
|
|
60
|
-
:'
|
|
61
|
-
:'
|
|
58
|
+
:'organization' => :'organization',
|
|
59
|
+
:'country' => :'country',
|
|
60
|
+
:'city' => :'city',
|
|
61
|
+
:'state' => :'state',
|
|
62
62
|
:'email' => :'email',
|
|
63
|
-
:'
|
|
64
|
-
:'
|
|
65
|
-
:'
|
|
66
|
-
:'
|
|
67
|
-
:'
|
|
68
|
-
:'
|
|
63
|
+
:'subject' => :'subject',
|
|
64
|
+
:'issuer' => :'issuer',
|
|
65
|
+
:'serial_number' => :'serialNumber',
|
|
66
|
+
:'valid_from' => :'validFrom',
|
|
67
|
+
:'valid_to' => :'validTo',
|
|
68
|
+
:'algorithm' => :'algorithm'
|
|
69
69
|
}
|
|
70
70
|
end
|
|
71
71
|
|
|
@@ -83,17 +83,17 @@ module FactPulse
|
|
|
83
83
|
def self.openapi_types
|
|
84
84
|
{
|
|
85
85
|
:'cn' => :'String',
|
|
86
|
-
:'
|
|
87
|
-
:'
|
|
88
|
-
:'
|
|
89
|
-
:'
|
|
86
|
+
:'organization' => :'String',
|
|
87
|
+
:'country' => :'String',
|
|
88
|
+
:'city' => :'String',
|
|
89
|
+
:'state' => :'String',
|
|
90
90
|
:'email' => :'String',
|
|
91
|
-
:'
|
|
92
|
-
:'
|
|
93
|
-
:'
|
|
94
|
-
:'
|
|
95
|
-
:'
|
|
96
|
-
:'
|
|
91
|
+
:'subject' => :'String',
|
|
92
|
+
:'issuer' => :'String',
|
|
93
|
+
:'serial_number' => :'Integer',
|
|
94
|
+
:'valid_from' => :'String',
|
|
95
|
+
:'valid_to' => :'String',
|
|
96
|
+
:'algorithm' => :'String'
|
|
97
97
|
}
|
|
98
98
|
end
|
|
99
99
|
|
|
@@ -126,68 +126,68 @@ module FactPulse
|
|
|
126
126
|
self.cn = nil
|
|
127
127
|
end
|
|
128
128
|
|
|
129
|
-
if attributes.key?(:'
|
|
130
|
-
self.
|
|
129
|
+
if attributes.key?(:'organization')
|
|
130
|
+
self.organization = attributes[:'organization']
|
|
131
131
|
else
|
|
132
|
-
self.
|
|
132
|
+
self.organization = nil
|
|
133
133
|
end
|
|
134
134
|
|
|
135
|
-
if attributes.key?(:'
|
|
136
|
-
self.
|
|
135
|
+
if attributes.key?(:'country')
|
|
136
|
+
self.country = attributes[:'country']
|
|
137
137
|
else
|
|
138
|
-
self.
|
|
138
|
+
self.country = nil
|
|
139
139
|
end
|
|
140
140
|
|
|
141
|
-
if attributes.key?(:'
|
|
142
|
-
self.
|
|
141
|
+
if attributes.key?(:'city')
|
|
142
|
+
self.city = attributes[:'city']
|
|
143
143
|
else
|
|
144
|
-
self.
|
|
144
|
+
self.city = nil
|
|
145
145
|
end
|
|
146
146
|
|
|
147
|
-
if attributes.key?(:'
|
|
148
|
-
self.
|
|
147
|
+
if attributes.key?(:'state')
|
|
148
|
+
self.state = attributes[:'state']
|
|
149
149
|
else
|
|
150
|
-
self.
|
|
150
|
+
self.state = nil
|
|
151
151
|
end
|
|
152
152
|
|
|
153
153
|
if attributes.key?(:'email')
|
|
154
154
|
self.email = attributes[:'email']
|
|
155
155
|
end
|
|
156
156
|
|
|
157
|
-
if attributes.key?(:'
|
|
158
|
-
self.
|
|
157
|
+
if attributes.key?(:'subject')
|
|
158
|
+
self.subject = attributes[:'subject']
|
|
159
159
|
else
|
|
160
|
-
self.
|
|
160
|
+
self.subject = nil
|
|
161
161
|
end
|
|
162
162
|
|
|
163
|
-
if attributes.key?(:'
|
|
164
|
-
self.
|
|
163
|
+
if attributes.key?(:'issuer')
|
|
164
|
+
self.issuer = attributes[:'issuer']
|
|
165
165
|
else
|
|
166
|
-
self.
|
|
166
|
+
self.issuer = nil
|
|
167
167
|
end
|
|
168
168
|
|
|
169
|
-
if attributes.key?(:'
|
|
170
|
-
self.
|
|
169
|
+
if attributes.key?(:'serial_number')
|
|
170
|
+
self.serial_number = attributes[:'serial_number']
|
|
171
171
|
else
|
|
172
|
-
self.
|
|
172
|
+
self.serial_number = nil
|
|
173
173
|
end
|
|
174
174
|
|
|
175
|
-
if attributes.key?(:'
|
|
176
|
-
self.
|
|
175
|
+
if attributes.key?(:'valid_from')
|
|
176
|
+
self.valid_from = attributes[:'valid_from']
|
|
177
177
|
else
|
|
178
|
-
self.
|
|
178
|
+
self.valid_from = nil
|
|
179
179
|
end
|
|
180
180
|
|
|
181
|
-
if attributes.key?(:'
|
|
182
|
-
self.
|
|
181
|
+
if attributes.key?(:'valid_to')
|
|
182
|
+
self.valid_to = attributes[:'valid_to']
|
|
183
183
|
else
|
|
184
|
-
self.
|
|
184
|
+
self.valid_to = nil
|
|
185
185
|
end
|
|
186
186
|
|
|
187
|
-
if attributes.key?(:'
|
|
188
|
-
self.
|
|
187
|
+
if attributes.key?(:'algorithm')
|
|
188
|
+
self.algorithm = attributes[:'algorithm']
|
|
189
189
|
else
|
|
190
|
-
self.
|
|
190
|
+
self.algorithm = nil
|
|
191
191
|
end
|
|
192
192
|
end
|
|
193
193
|
|
|
@@ -200,44 +200,44 @@ module FactPulse
|
|
|
200
200
|
invalid_properties.push('invalid value for "cn", cn cannot be nil.')
|
|
201
201
|
end
|
|
202
202
|
|
|
203
|
-
if @
|
|
204
|
-
invalid_properties.push('invalid value for "
|
|
203
|
+
if @organization.nil?
|
|
204
|
+
invalid_properties.push('invalid value for "organization", organization cannot be nil.')
|
|
205
205
|
end
|
|
206
206
|
|
|
207
|
-
if @
|
|
208
|
-
invalid_properties.push('invalid value for "
|
|
207
|
+
if @country.nil?
|
|
208
|
+
invalid_properties.push('invalid value for "country", country cannot be nil.')
|
|
209
209
|
end
|
|
210
210
|
|
|
211
|
-
if @
|
|
212
|
-
invalid_properties.push('invalid value for "
|
|
211
|
+
if @city.nil?
|
|
212
|
+
invalid_properties.push('invalid value for "city", city cannot be nil.')
|
|
213
213
|
end
|
|
214
214
|
|
|
215
|
-
if @
|
|
216
|
-
invalid_properties.push('invalid value for "
|
|
215
|
+
if @state.nil?
|
|
216
|
+
invalid_properties.push('invalid value for "state", state cannot be nil.')
|
|
217
217
|
end
|
|
218
218
|
|
|
219
|
-
if @
|
|
220
|
-
invalid_properties.push('invalid value for "
|
|
219
|
+
if @subject.nil?
|
|
220
|
+
invalid_properties.push('invalid value for "subject", subject cannot be nil.')
|
|
221
221
|
end
|
|
222
222
|
|
|
223
|
-
if @
|
|
224
|
-
invalid_properties.push('invalid value for "
|
|
223
|
+
if @issuer.nil?
|
|
224
|
+
invalid_properties.push('invalid value for "issuer", issuer cannot be nil.')
|
|
225
225
|
end
|
|
226
226
|
|
|
227
|
-
if @
|
|
228
|
-
invalid_properties.push('invalid value for "
|
|
227
|
+
if @serial_number.nil?
|
|
228
|
+
invalid_properties.push('invalid value for "serial_number", serial_number cannot be nil.')
|
|
229
229
|
end
|
|
230
230
|
|
|
231
|
-
if @
|
|
232
|
-
invalid_properties.push('invalid value for "
|
|
231
|
+
if @valid_from.nil?
|
|
232
|
+
invalid_properties.push('invalid value for "valid_from", valid_from cannot be nil.')
|
|
233
233
|
end
|
|
234
234
|
|
|
235
|
-
if @
|
|
236
|
-
invalid_properties.push('invalid value for "
|
|
235
|
+
if @valid_to.nil?
|
|
236
|
+
invalid_properties.push('invalid value for "valid_to", valid_to cannot be nil.')
|
|
237
237
|
end
|
|
238
238
|
|
|
239
|
-
if @
|
|
240
|
-
invalid_properties.push('invalid value for "
|
|
239
|
+
if @algorithm.nil?
|
|
240
|
+
invalid_properties.push('invalid value for "algorithm", algorithm cannot be nil.')
|
|
241
241
|
end
|
|
242
242
|
|
|
243
243
|
invalid_properties
|
|
@@ -248,16 +248,16 @@ module FactPulse
|
|
|
248
248
|
def valid?
|
|
249
249
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
250
250
|
return false if @cn.nil?
|
|
251
|
-
return false if @
|
|
252
|
-
return false if @
|
|
253
|
-
return false if @
|
|
254
|
-
return false if @
|
|
255
|
-
return false if @
|
|
256
|
-
return false if @
|
|
257
|
-
return false if @
|
|
258
|
-
return false if @
|
|
259
|
-
return false if @
|
|
260
|
-
return false if @
|
|
251
|
+
return false if @organization.nil?
|
|
252
|
+
return false if @country.nil?
|
|
253
|
+
return false if @city.nil?
|
|
254
|
+
return false if @state.nil?
|
|
255
|
+
return false if @subject.nil?
|
|
256
|
+
return false if @issuer.nil?
|
|
257
|
+
return false if @serial_number.nil?
|
|
258
|
+
return false if @valid_from.nil?
|
|
259
|
+
return false if @valid_to.nil?
|
|
260
|
+
return false if @algorithm.nil?
|
|
261
261
|
true
|
|
262
262
|
end
|
|
263
263
|
|
|
@@ -272,103 +272,103 @@ module FactPulse
|
|
|
272
272
|
end
|
|
273
273
|
|
|
274
274
|
# Custom attribute writer method with validation
|
|
275
|
-
# @param [Object]
|
|
276
|
-
def
|
|
277
|
-
if
|
|
278
|
-
fail ArgumentError, '
|
|
275
|
+
# @param [Object] organization Value to be assigned
|
|
276
|
+
def organization=(organization)
|
|
277
|
+
if organization.nil?
|
|
278
|
+
fail ArgumentError, 'organization cannot be nil'
|
|
279
279
|
end
|
|
280
280
|
|
|
281
|
-
@
|
|
281
|
+
@organization = organization
|
|
282
282
|
end
|
|
283
283
|
|
|
284
284
|
# Custom attribute writer method with validation
|
|
285
|
-
# @param [Object]
|
|
286
|
-
def
|
|
287
|
-
if
|
|
288
|
-
fail ArgumentError, '
|
|
285
|
+
# @param [Object] country Value to be assigned
|
|
286
|
+
def country=(country)
|
|
287
|
+
if country.nil?
|
|
288
|
+
fail ArgumentError, 'country cannot be nil'
|
|
289
289
|
end
|
|
290
290
|
|
|
291
|
-
@
|
|
291
|
+
@country = country
|
|
292
292
|
end
|
|
293
293
|
|
|
294
294
|
# Custom attribute writer method with validation
|
|
295
|
-
# @param [Object]
|
|
296
|
-
def
|
|
297
|
-
if
|
|
298
|
-
fail ArgumentError, '
|
|
295
|
+
# @param [Object] city Value to be assigned
|
|
296
|
+
def city=(city)
|
|
297
|
+
if city.nil?
|
|
298
|
+
fail ArgumentError, 'city cannot be nil'
|
|
299
299
|
end
|
|
300
300
|
|
|
301
|
-
@
|
|
301
|
+
@city = city
|
|
302
302
|
end
|
|
303
303
|
|
|
304
304
|
# Custom attribute writer method with validation
|
|
305
|
-
# @param [Object]
|
|
306
|
-
def
|
|
307
|
-
if
|
|
308
|
-
fail ArgumentError, '
|
|
305
|
+
# @param [Object] state Value to be assigned
|
|
306
|
+
def state=(state)
|
|
307
|
+
if state.nil?
|
|
308
|
+
fail ArgumentError, 'state cannot be nil'
|
|
309
309
|
end
|
|
310
310
|
|
|
311
|
-
@
|
|
311
|
+
@state = state
|
|
312
312
|
end
|
|
313
313
|
|
|
314
314
|
# Custom attribute writer method with validation
|
|
315
|
-
# @param [Object]
|
|
316
|
-
def
|
|
317
|
-
if
|
|
318
|
-
fail ArgumentError, '
|
|
315
|
+
# @param [Object] subject Value to be assigned
|
|
316
|
+
def subject=(subject)
|
|
317
|
+
if subject.nil?
|
|
318
|
+
fail ArgumentError, 'subject cannot be nil'
|
|
319
319
|
end
|
|
320
320
|
|
|
321
|
-
@
|
|
321
|
+
@subject = subject
|
|
322
322
|
end
|
|
323
323
|
|
|
324
324
|
# Custom attribute writer method with validation
|
|
325
|
-
# @param [Object]
|
|
326
|
-
def
|
|
327
|
-
if
|
|
328
|
-
fail ArgumentError, '
|
|
325
|
+
# @param [Object] issuer Value to be assigned
|
|
326
|
+
def issuer=(issuer)
|
|
327
|
+
if issuer.nil?
|
|
328
|
+
fail ArgumentError, 'issuer cannot be nil'
|
|
329
329
|
end
|
|
330
330
|
|
|
331
|
-
@
|
|
331
|
+
@issuer = issuer
|
|
332
332
|
end
|
|
333
333
|
|
|
334
334
|
# Custom attribute writer method with validation
|
|
335
|
-
# @param [Object]
|
|
336
|
-
def
|
|
337
|
-
if
|
|
338
|
-
fail ArgumentError, '
|
|
335
|
+
# @param [Object] serial_number Value to be assigned
|
|
336
|
+
def serial_number=(serial_number)
|
|
337
|
+
if serial_number.nil?
|
|
338
|
+
fail ArgumentError, 'serial_number cannot be nil'
|
|
339
339
|
end
|
|
340
340
|
|
|
341
|
-
@
|
|
341
|
+
@serial_number = serial_number
|
|
342
342
|
end
|
|
343
343
|
|
|
344
344
|
# Custom attribute writer method with validation
|
|
345
|
-
# @param [Object]
|
|
346
|
-
def
|
|
347
|
-
if
|
|
348
|
-
fail ArgumentError, '
|
|
345
|
+
# @param [Object] valid_from Value to be assigned
|
|
346
|
+
def valid_from=(valid_from)
|
|
347
|
+
if valid_from.nil?
|
|
348
|
+
fail ArgumentError, 'valid_from cannot be nil'
|
|
349
349
|
end
|
|
350
350
|
|
|
351
|
-
@
|
|
351
|
+
@valid_from = valid_from
|
|
352
352
|
end
|
|
353
353
|
|
|
354
354
|
# Custom attribute writer method with validation
|
|
355
|
-
# @param [Object]
|
|
356
|
-
def
|
|
357
|
-
if
|
|
358
|
-
fail ArgumentError, '
|
|
355
|
+
# @param [Object] valid_to Value to be assigned
|
|
356
|
+
def valid_to=(valid_to)
|
|
357
|
+
if valid_to.nil?
|
|
358
|
+
fail ArgumentError, 'valid_to cannot be nil'
|
|
359
359
|
end
|
|
360
360
|
|
|
361
|
-
@
|
|
361
|
+
@valid_to = valid_to
|
|
362
362
|
end
|
|
363
363
|
|
|
364
364
|
# Custom attribute writer method with validation
|
|
365
|
-
# @param [Object]
|
|
366
|
-
def
|
|
367
|
-
if
|
|
368
|
-
fail ArgumentError, '
|
|
365
|
+
# @param [Object] algorithm Value to be assigned
|
|
366
|
+
def algorithm=(algorithm)
|
|
367
|
+
if algorithm.nil?
|
|
368
|
+
fail ArgumentError, 'algorithm cannot be nil'
|
|
369
369
|
end
|
|
370
370
|
|
|
371
|
-
@
|
|
371
|
+
@algorithm = algorithm
|
|
372
372
|
end
|
|
373
373
|
|
|
374
374
|
# Checks equality by comparing each attribute.
|
|
@@ -377,17 +377,17 @@ module FactPulse
|
|
|
377
377
|
return true if self.equal?(o)
|
|
378
378
|
self.class == o.class &&
|
|
379
379
|
cn == o.cn &&
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
380
|
+
organization == o.organization &&
|
|
381
|
+
country == o.country &&
|
|
382
|
+
city == o.city &&
|
|
383
|
+
state == o.state &&
|
|
384
384
|
email == o.email &&
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
385
|
+
subject == o.subject &&
|
|
386
|
+
issuer == o.issuer &&
|
|
387
|
+
serial_number == o.serial_number &&
|
|
388
|
+
valid_from == o.valid_from &&
|
|
389
|
+
valid_to == o.valid_to &&
|
|
390
|
+
algorithm == o.algorithm
|
|
391
391
|
end
|
|
392
392
|
|
|
393
393
|
# @see the `==` method
|
|
@@ -399,7 +399,7 @@ module FactPulse
|
|
|
399
399
|
# Calculates hash code according to all attributes.
|
|
400
400
|
# @return [Integer] Hash code
|
|
401
401
|
def hash
|
|
402
|
-
[cn,
|
|
402
|
+
[cn, organization, country, city, state, email, subject, issuer, serial_number, valid_from, valid_to, algorithm].hash
|
|
403
403
|
end
|
|
404
404
|
|
|
405
405
|
# Builds the object from hash
|
|
@@ -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
|
|
|
@@ -14,8 +14,8 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module FactPulse
|
|
17
|
-
#
|
|
18
|
-
class
|
|
17
|
+
# Specific configuration for Chorus Pro destination.
|
|
18
|
+
class ChorusProDestination < ApiModelBase
|
|
19
19
|
attr_accessor :type
|
|
20
20
|
|
|
21
21
|
attr_accessor :credentials
|
|
@@ -64,7 +64,7 @@ module FactPulse
|
|
|
64
64
|
def self.openapi_types
|
|
65
65
|
{
|
|
66
66
|
:'type' => :'String',
|
|
67
|
-
:'credentials' => :'
|
|
67
|
+
:'credentials' => :'FactureElectroniqueRestApiSchemasProcessingChorusProCredentials'
|
|
68
68
|
}
|
|
69
69
|
end
|
|
70
70
|
|
|
@@ -79,14 +79,14 @@ module FactPulse
|
|
|
79
79
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
80
80
|
def initialize(attributes = {})
|
|
81
81
|
if (!attributes.is_a?(Hash))
|
|
82
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::
|
|
82
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::ChorusProDestination` initialize method"
|
|
83
83
|
end
|
|
84
84
|
|
|
85
85
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
86
86
|
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
87
87
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
88
88
|
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
89
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::
|
|
89
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::ChorusProDestination`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
90
90
|
end
|
|
91
91
|
h[k.to_sym] = v
|
|
92
92
|
}
|