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
|
|
|
@@ -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
|
+
# Add an attachment
|
|
23
|
+
# Add an attachment to the current user account. **Max size**: 10 MB per file **Example payload**: ```json { \"pieceJointeFichier\": \"JVBERi0xLjQKJeLjz9MKNSAwIG9iago8P...\", \"pieceJointeNom\": \"purchase_order.pdf\", \"pieceJointeTypeMime\": \"application/pdf\", \"pieceJointeExtension\": \"PDF\" } ``` **Returns**: The attachment ID (`pieceJointeIdFichier`) to use in `/factures/completer`. **Accepted extensions**: PDF, JPG, PNG, ZIP, XML, etc.
|
|
24
24
|
# @param request_body [Hash<String, Object>]
|
|
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
|
+
# Add an attachment
|
|
33
|
+
# Add an attachment to the current user account. **Max size**: 10 MB per file **Example payload**: ```json { \"pieceJointeFichier\": \"JVBERi0xLjQKJeLjz9MKNSAwIG9iago8P...\", \"pieceJointeNom\": \"purchase_order.pdf\", \"pieceJointeTypeMime\": \"application/pdf\", \"pieceJointeExtension\": \"PDF\" } ``` **Returns**: The attachment ID (`pieceJointeIdFichier`) to use in `/factures/completer`. **Accepted extensions**: PDF, JPG, PNG, ZIP, XML, etc.
|
|
34
34
|
# @param request_body [Hash<String, Object>]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -87,8 +87,8 @@ module FactPulse
|
|
|
87
87
|
return data, status_code, headers
|
|
88
88
|
end
|
|
89
89
|
|
|
90
|
-
#
|
|
91
|
-
#
|
|
90
|
+
# Complete a suspended invoice (Supplier)
|
|
91
|
+
# Complete a SUSPENDUE status invoice by adding attachments or a comment. **Required status**: SUSPENDUE **Possible actions**: - Add attachments (supporting documents, purchase orders, etc.) - Modify comment **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"commentaire\": \"Here are the requested documents\", \"listePiecesJointes\": [ { \"pieceJointeIdFichier\": 98765, \"pieceJointeNom\": \"purchase_order.pdf\" } ] } ``` **Note**: Attachments must first be uploaded via `/transverses/ajouter-fichier`. **After completion**: The invoice returns to MISE_A_DISPOSITION status.
|
|
92
92
|
# @param request_body [Hash<String, Object>]
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
94
|
# @return [Object]
|
|
@@ -97,8 +97,8 @@ module FactPulse
|
|
|
97
97
|
data
|
|
98
98
|
end
|
|
99
99
|
|
|
100
|
-
#
|
|
101
|
-
#
|
|
100
|
+
# Complete a suspended invoice (Supplier)
|
|
101
|
+
# Complete a SUSPENDUE status invoice by adding attachments or a comment. **Required status**: SUSPENDUE **Possible actions**: - Add attachments (supporting documents, purchase orders, etc.) - Modify comment **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"commentaire\": \"Here are the requested documents\", \"listePiecesJointes\": [ { \"pieceJointeIdFichier\": 98765, \"pieceJointeNom\": \"purchase_order.pdf\" } ] } ``` **Note**: Attachments must first be uploaded via `/transverses/ajouter-fichier`. **After completion**: The invoice returns to MISE_A_DISPOSITION status.
|
|
102
102
|
# @param request_body [Hash<String, Object>]
|
|
103
103
|
# @param [Hash] opts the optional parameters
|
|
104
104
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -155,28 +155,28 @@ module FactPulse
|
|
|
155
155
|
return data, status_code, headers
|
|
156
156
|
end
|
|
157
157
|
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
# @param
|
|
158
|
+
# Consult invoice status
|
|
159
|
+
# Retrieves the information and current status of an invoice submitted to Chorus Pro. **Returns**: - Invoice number and date - Total gross amount - **Current status**: SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc. - Recipient structure **Use cases**: - Track the processing progress of an invoice - Check if an invoice has been validated or rejected - Get the payment date **Polling**: Call this endpoint regularly to track status changes.
|
|
160
|
+
# @param get_invoice_request [GetInvoiceRequest]
|
|
161
161
|
# @param [Hash] opts the optional parameters
|
|
162
|
-
# @return [
|
|
163
|
-
def consulter_facture_api_v1_chorus_pro_factures_consulter_post(
|
|
164
|
-
data, _status_code, _headers = consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(
|
|
162
|
+
# @return [GetInvoiceResponse]
|
|
163
|
+
def consulter_facture_api_v1_chorus_pro_factures_consulter_post(get_invoice_request, opts = {})
|
|
164
|
+
data, _status_code, _headers = consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(get_invoice_request, opts)
|
|
165
165
|
data
|
|
166
166
|
end
|
|
167
167
|
|
|
168
|
-
#
|
|
169
|
-
#
|
|
170
|
-
# @param
|
|
168
|
+
# Consult invoice status
|
|
169
|
+
# Retrieves the information and current status of an invoice submitted to Chorus Pro. **Returns**: - Invoice number and date - Total gross amount - **Current status**: SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc. - Recipient structure **Use cases**: - Track the processing progress of an invoice - Check if an invoice has been validated or rejected - Get the payment date **Polling**: Call this endpoint regularly to track status changes.
|
|
170
|
+
# @param get_invoice_request [GetInvoiceRequest]
|
|
171
171
|
# @param [Hash] opts the optional parameters
|
|
172
|
-
# @return [Array<(
|
|
173
|
-
def consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(
|
|
172
|
+
# @return [Array<(GetInvoiceResponse, Integer, Hash)>] GetInvoiceResponse data, response status code and response headers
|
|
173
|
+
def consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(get_invoice_request, opts = {})
|
|
174
174
|
if @api_client.config.debugging
|
|
175
175
|
@api_client.config.logger.debug 'Calling API: ChorusProApi.consulter_facture_api_v1_chorus_pro_factures_consulter_post ...'
|
|
176
176
|
end
|
|
177
|
-
# verify the required parameter '
|
|
178
|
-
if @api_client.config.client_side_validation &&
|
|
179
|
-
fail ArgumentError, "Missing the required parameter '
|
|
177
|
+
# verify the required parameter 'get_invoice_request' is set
|
|
178
|
+
if @api_client.config.client_side_validation && get_invoice_request.nil?
|
|
179
|
+
fail ArgumentError, "Missing the required parameter 'get_invoice_request' when calling ChorusProApi.consulter_facture_api_v1_chorus_pro_factures_consulter_post"
|
|
180
180
|
end
|
|
181
181
|
# resource path
|
|
182
182
|
local_var_path = '/api/v1/chorus-pro/factures/consulter'
|
|
@@ -198,10 +198,10 @@ module FactPulse
|
|
|
198
198
|
form_params = opts[:form_params] || {}
|
|
199
199
|
|
|
200
200
|
# http body (model)
|
|
201
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
201
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_invoice_request)
|
|
202
202
|
|
|
203
203
|
# return_type
|
|
204
|
-
return_type = opts[:debug_return_type] || '
|
|
204
|
+
return_type = opts[:debug_return_type] || 'GetInvoiceResponse'
|
|
205
205
|
|
|
206
206
|
# auth_names
|
|
207
207
|
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
|
@@ -223,28 +223,28 @@ module FactPulse
|
|
|
223
223
|
return data, status_code, headers
|
|
224
224
|
end
|
|
225
225
|
|
|
226
|
-
#
|
|
227
|
-
#
|
|
228
|
-
# @param
|
|
226
|
+
# Consult structure details
|
|
227
|
+
# Retrieves detailed information about a Chorus Pro structure. **Returns**: - Company name - Intra-EU VAT number - Contact email - **Required parameters**: Indicates if service code and/or engagement number are required to submit an invoice **Typical step**: Called after `search-structures` to know which fields are mandatory before submitting an invoice.
|
|
228
|
+
# @param get_structure_request [GetStructureRequest]
|
|
229
229
|
# @param [Hash] opts the optional parameters
|
|
230
|
-
# @return [
|
|
231
|
-
def consulter_structure_api_v1_chorus_pro_structures_consulter_post(
|
|
232
|
-
data, _status_code, _headers = consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(
|
|
230
|
+
# @return [GetStructureResponse]
|
|
231
|
+
def consulter_structure_api_v1_chorus_pro_structures_consulter_post(get_structure_request, opts = {})
|
|
232
|
+
data, _status_code, _headers = consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(get_structure_request, opts)
|
|
233
233
|
data
|
|
234
234
|
end
|
|
235
235
|
|
|
236
|
-
#
|
|
237
|
-
#
|
|
238
|
-
# @param
|
|
236
|
+
# Consult structure details
|
|
237
|
+
# Retrieves detailed information about a Chorus Pro structure. **Returns**: - Company name - Intra-EU VAT number - Contact email - **Required parameters**: Indicates if service code and/or engagement number are required to submit an invoice **Typical step**: Called after `search-structures` to know which fields are mandatory before submitting an invoice.
|
|
238
|
+
# @param get_structure_request [GetStructureRequest]
|
|
239
239
|
# @param [Hash] opts the optional parameters
|
|
240
|
-
# @return [Array<(
|
|
241
|
-
def consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(
|
|
240
|
+
# @return [Array<(GetStructureResponse, Integer, Hash)>] GetStructureResponse data, response status code and response headers
|
|
241
|
+
def consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(get_structure_request, opts = {})
|
|
242
242
|
if @api_client.config.debugging
|
|
243
243
|
@api_client.config.logger.debug 'Calling API: ChorusProApi.consulter_structure_api_v1_chorus_pro_structures_consulter_post ...'
|
|
244
244
|
end
|
|
245
|
-
# verify the required parameter '
|
|
246
|
-
if @api_client.config.client_side_validation &&
|
|
247
|
-
fail ArgumentError, "Missing the required parameter '
|
|
245
|
+
# verify the required parameter 'get_structure_request' is set
|
|
246
|
+
if @api_client.config.client_side_validation && get_structure_request.nil?
|
|
247
|
+
fail ArgumentError, "Missing the required parameter 'get_structure_request' when calling ChorusProApi.consulter_structure_api_v1_chorus_pro_structures_consulter_post"
|
|
248
248
|
end
|
|
249
249
|
# resource path
|
|
250
250
|
local_var_path = '/api/v1/chorus-pro/structures/consulter'
|
|
@@ -266,10 +266,10 @@ module FactPulse
|
|
|
266
266
|
form_params = opts[:form_params] || {}
|
|
267
267
|
|
|
268
268
|
# http body (model)
|
|
269
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
269
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_structure_request)
|
|
270
270
|
|
|
271
271
|
# return_type
|
|
272
|
-
return_type = opts[:debug_return_type] || '
|
|
272
|
+
return_type = opts[:debug_return_type] || 'GetStructureResponse'
|
|
273
273
|
|
|
274
274
|
# auth_names
|
|
275
275
|
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
|
@@ -291,21 +291,21 @@ module FactPulse
|
|
|
291
291
|
return data, status_code, headers
|
|
292
292
|
end
|
|
293
293
|
|
|
294
|
-
#
|
|
295
|
-
#
|
|
294
|
+
# List structure services
|
|
295
|
+
# Retrieves the list of active services for a public structure. **Use cases**: - List available services for an administration - Verify that a service code exists before submitting an invoice **Returns**: - List of services with their code, label, and status (active/inactive)
|
|
296
296
|
# @param id_structure_cpp [Integer]
|
|
297
297
|
# @param [Hash] opts the optional parameters
|
|
298
|
-
# @return [
|
|
298
|
+
# @return [SearchServicesResponse]
|
|
299
299
|
def lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get(id_structure_cpp, opts = {})
|
|
300
300
|
data, _status_code, _headers = lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info(id_structure_cpp, opts)
|
|
301
301
|
data
|
|
302
302
|
end
|
|
303
303
|
|
|
304
|
-
#
|
|
305
|
-
#
|
|
304
|
+
# List structure services
|
|
305
|
+
# Retrieves the list of active services for a public structure. **Use cases**: - List available services for an administration - Verify that a service code exists before submitting an invoice **Returns**: - List of services with their code, label, and status (active/inactive)
|
|
306
306
|
# @param id_structure_cpp [Integer]
|
|
307
307
|
# @param [Hash] opts the optional parameters
|
|
308
|
-
# @return [Array<(
|
|
308
|
+
# @return [Array<(SearchServicesResponse, Integer, Hash)>] SearchServicesResponse data, response status code and response headers
|
|
309
309
|
def lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info(id_structure_cpp, opts = {})
|
|
310
310
|
if @api_client.config.debugging
|
|
311
311
|
@api_client.config.logger.debug 'Calling API: ChorusProApi.lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get ...'
|
|
@@ -332,7 +332,7 @@ module FactPulse
|
|
|
332
332
|
post_body = opts[:debug_body]
|
|
333
333
|
|
|
334
334
|
# return_type
|
|
335
|
-
return_type = opts[:debug_return_type] || '
|
|
335
|
+
return_type = opts[:debug_return_type] || 'SearchServicesResponse'
|
|
336
336
|
|
|
337
337
|
# auth_names
|
|
338
338
|
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
|
@@ -354,28 +354,28 @@ module FactPulse
|
|
|
354
354
|
return data, status_code, headers
|
|
355
355
|
end
|
|
356
356
|
|
|
357
|
-
#
|
|
358
|
-
# **
|
|
359
|
-
# @param
|
|
357
|
+
# Utility: Get Chorus Pro ID from SIRET
|
|
358
|
+
# **Convenient utility** to get a structure's Chorus Pro ID from its SIRET. This wrapper function combines: 1. Searching for the structure by SIRET 2. Extracting the `id_structure_cpp` if a single structure is found **Returns**: - `id_structure_cpp`: Chorus Pro ID (0 if not found or multiple results) - `designation_structure`: Structure name (if found) - `message`: Explanatory message **Use cases**: - Shortcut to directly get the Chorus Pro ID before submitting an invoice - Simplified alternative to `search-structures` + manual ID extraction **Note**: If multiple structures match the SIRET (rare), returns 0 and an error message.
|
|
359
|
+
# @param get_chorus_pro_id_request [GetChorusProIdRequest]
|
|
360
360
|
# @param [Hash] opts the optional parameters
|
|
361
|
-
# @return [
|
|
362
|
-
def obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(
|
|
363
|
-
data, _status_code, _headers = obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(
|
|
361
|
+
# @return [GetChorusProIdResponse]
|
|
362
|
+
def obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(get_chorus_pro_id_request, opts = {})
|
|
363
|
+
data, _status_code, _headers = obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(get_chorus_pro_id_request, opts)
|
|
364
364
|
data
|
|
365
365
|
end
|
|
366
366
|
|
|
367
|
-
#
|
|
368
|
-
# **
|
|
369
|
-
# @param
|
|
367
|
+
# Utility: Get Chorus Pro ID from SIRET
|
|
368
|
+
# **Convenient utility** to get a structure's Chorus Pro ID from its SIRET. This wrapper function combines: 1. Searching for the structure by SIRET 2. Extracting the `id_structure_cpp` if a single structure is found **Returns**: - `id_structure_cpp`: Chorus Pro ID (0 if not found or multiple results) - `designation_structure`: Structure name (if found) - `message`: Explanatory message **Use cases**: - Shortcut to directly get the Chorus Pro ID before submitting an invoice - Simplified alternative to `search-structures` + manual ID extraction **Note**: If multiple structures match the SIRET (rare), returns 0 and an error message.
|
|
369
|
+
# @param get_chorus_pro_id_request [GetChorusProIdRequest]
|
|
370
370
|
# @param [Hash] opts the optional parameters
|
|
371
|
-
# @return [Array<(
|
|
372
|
-
def obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(
|
|
371
|
+
# @return [Array<(GetChorusProIdResponse, Integer, Hash)>] GetChorusProIdResponse data, response status code and response headers
|
|
372
|
+
def obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(get_chorus_pro_id_request, opts = {})
|
|
373
373
|
if @api_client.config.debugging
|
|
374
374
|
@api_client.config.logger.debug 'Calling API: ChorusProApi.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post ...'
|
|
375
375
|
end
|
|
376
|
-
# verify the required parameter '
|
|
377
|
-
if @api_client.config.client_side_validation &&
|
|
378
|
-
fail ArgumentError, "Missing the required parameter '
|
|
376
|
+
# verify the required parameter 'get_chorus_pro_id_request' is set
|
|
377
|
+
if @api_client.config.client_side_validation && get_chorus_pro_id_request.nil?
|
|
378
|
+
fail ArgumentError, "Missing the required parameter 'get_chorus_pro_id_request' when calling ChorusProApi.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post"
|
|
379
379
|
end
|
|
380
380
|
# resource path
|
|
381
381
|
local_var_path = '/api/v1/chorus-pro/structures/obtenir-id-depuis-siret'
|
|
@@ -397,10 +397,10 @@ module FactPulse
|
|
|
397
397
|
form_params = opts[:form_params] || {}
|
|
398
398
|
|
|
399
399
|
# http body (model)
|
|
400
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
400
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_chorus_pro_id_request)
|
|
401
401
|
|
|
402
402
|
# return_type
|
|
403
|
-
return_type = opts[:debug_return_type] || '
|
|
403
|
+
return_type = opts[:debug_return_type] || 'GetChorusProIdResponse'
|
|
404
404
|
|
|
405
405
|
# auth_names
|
|
406
406
|
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
|
@@ -422,8 +422,8 @@ module FactPulse
|
|
|
422
422
|
return data, status_code, headers
|
|
423
423
|
end
|
|
424
424
|
|
|
425
|
-
#
|
|
426
|
-
#
|
|
425
|
+
# Search received invoices (Recipient)
|
|
426
|
+
# Search invoices received by the connected recipient. **Filters**: - Downloaded / not downloaded - Reception dates - Status (MISE_A_DISPOSITION, SUSPENDUE, etc.) - Supplier **Useful indicator**: `factureTelechargeeParDestinataire` indicates whether the invoice has already been downloaded.
|
|
427
427
|
# @param request_body [Hash<String, Object>]
|
|
428
428
|
# @param [Hash] opts the optional parameters
|
|
429
429
|
# @return [Object]
|
|
@@ -432,8 +432,8 @@ module FactPulse
|
|
|
432
432
|
data
|
|
433
433
|
end
|
|
434
434
|
|
|
435
|
-
#
|
|
436
|
-
#
|
|
435
|
+
# Search received invoices (Recipient)
|
|
436
|
+
# Search invoices received by the connected recipient. **Filters**: - Downloaded / not downloaded - Reception dates - Status (MISE_A_DISPOSITION, SUSPENDUE, etc.) - Supplier **Useful indicator**: `factureTelechargeeParDestinataire` indicates whether the invoice has already been downloaded.
|
|
437
437
|
# @param request_body [Hash<String, Object>]
|
|
438
438
|
# @param [Hash] opts the optional parameters
|
|
439
439
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -490,8 +490,8 @@ module FactPulse
|
|
|
490
490
|
return data, status_code, headers
|
|
491
491
|
end
|
|
492
492
|
|
|
493
|
-
#
|
|
494
|
-
#
|
|
493
|
+
# Search issued invoices (Supplier)
|
|
494
|
+
# Search invoices issued by the connected supplier. **Available filters**: - Invoice number - Dates (start/end) - Status - Recipient structure - Amount **Use cases**: - Track issued invoices - Verify statuses - Export for accounting
|
|
495
495
|
# @param request_body [Hash<String, Object>]
|
|
496
496
|
# @param [Hash] opts the optional parameters
|
|
497
497
|
# @return [Object]
|
|
@@ -500,8 +500,8 @@ module FactPulse
|
|
|
500
500
|
data
|
|
501
501
|
end
|
|
502
502
|
|
|
503
|
-
#
|
|
504
|
-
#
|
|
503
|
+
# Search issued invoices (Supplier)
|
|
504
|
+
# Search invoices issued by the connected supplier. **Available filters**: - Invoice number - Dates (start/end) - Status - Recipient structure - Amount **Use cases**: - Track issued invoices - Verify statuses - Export for accounting
|
|
505
505
|
# @param request_body [Hash<String, Object>]
|
|
506
506
|
# @param [Hash] opts the optional parameters
|
|
507
507
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -558,28 +558,28 @@ module FactPulse
|
|
|
558
558
|
return data, status_code, headers
|
|
559
559
|
end
|
|
560
560
|
|
|
561
|
-
#
|
|
562
|
-
#
|
|
563
|
-
# @param
|
|
561
|
+
# Search Chorus Pro structures
|
|
562
|
+
# Search for structures (companies, administrations) registered on Chorus Pro. **Use cases**: - Find the Chorus Pro ID of a structure from its SIRET - Check if a structure is registered on Chorus Pro - List structures matching criteria **Available filters**: - Identifier (SIRET, SIREN, etc.) - Company name - Identifier type - Private structures only **Typical step**: Called before `submit-invoice` to get the recipient's `id_structure_cpp`.
|
|
563
|
+
# @param search_structure_request [SearchStructureRequest]
|
|
564
564
|
# @param [Hash] opts the optional parameters
|
|
565
|
-
# @return [
|
|
566
|
-
def rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(
|
|
567
|
-
data, _status_code, _headers = rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(
|
|
565
|
+
# @return [SearchStructureResponse]
|
|
566
|
+
def rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(search_structure_request, opts = {})
|
|
567
|
+
data, _status_code, _headers = rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(search_structure_request, opts)
|
|
568
568
|
data
|
|
569
569
|
end
|
|
570
570
|
|
|
571
|
-
#
|
|
572
|
-
#
|
|
573
|
-
# @param
|
|
571
|
+
# Search Chorus Pro structures
|
|
572
|
+
# Search for structures (companies, administrations) registered on Chorus Pro. **Use cases**: - Find the Chorus Pro ID of a structure from its SIRET - Check if a structure is registered on Chorus Pro - List structures matching criteria **Available filters**: - Identifier (SIRET, SIREN, etc.) - Company name - Identifier type - Private structures only **Typical step**: Called before `submit-invoice` to get the recipient's `id_structure_cpp`.
|
|
573
|
+
# @param search_structure_request [SearchStructureRequest]
|
|
574
574
|
# @param [Hash] opts the optional parameters
|
|
575
|
-
# @return [Array<(
|
|
576
|
-
def rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(
|
|
575
|
+
# @return [Array<(SearchStructureResponse, Integer, Hash)>] SearchStructureResponse data, response status code and response headers
|
|
576
|
+
def rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(search_structure_request, opts = {})
|
|
577
577
|
if @api_client.config.debugging
|
|
578
578
|
@api_client.config.logger.debug 'Calling API: ChorusProApi.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post ...'
|
|
579
579
|
end
|
|
580
|
-
# verify the required parameter '
|
|
581
|
-
if @api_client.config.client_side_validation &&
|
|
582
|
-
fail ArgumentError, "Missing the required parameter '
|
|
580
|
+
# verify the required parameter 'search_structure_request' is set
|
|
581
|
+
if @api_client.config.client_side_validation && search_structure_request.nil?
|
|
582
|
+
fail ArgumentError, "Missing the required parameter 'search_structure_request' when calling ChorusProApi.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post"
|
|
583
583
|
end
|
|
584
584
|
# resource path
|
|
585
585
|
local_var_path = '/api/v1/chorus-pro/structures/rechercher'
|
|
@@ -601,10 +601,10 @@ module FactPulse
|
|
|
601
601
|
form_params = opts[:form_params] || {}
|
|
602
602
|
|
|
603
603
|
# http body (model)
|
|
604
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
604
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_structure_request)
|
|
605
605
|
|
|
606
606
|
# return_type
|
|
607
|
-
return_type = opts[:debug_return_type] || '
|
|
607
|
+
return_type = opts[:debug_return_type] || 'SearchStructureResponse'
|
|
608
608
|
|
|
609
609
|
# auth_names
|
|
610
610
|
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
|
@@ -626,8 +626,8 @@ module FactPulse
|
|
|
626
626
|
return data, status_code, headers
|
|
627
627
|
end
|
|
628
628
|
|
|
629
|
-
#
|
|
630
|
-
# Recycle
|
|
629
|
+
# Recycle an invoice (Supplier)
|
|
630
|
+
# Recycle an invoice with A_RECYCLER status by modifying routing data. **Required status**: A_RECYCLER **Modifiable fields**: - Recipient (`idStructureCPP`) - Service code - Engagement number **Use cases**: - Wrong recipient - Change of billing service - Update engagement number **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"idStructureCPP\": 67890, \"codeService\": \"SERVICE_01\", \"numeroEngagement\": \"ENG2024001\" } ``` **Note**: The invoice keeps its number and amounts, only routing fields change.
|
|
631
631
|
# @param request_body [Hash<String, Object>]
|
|
632
632
|
# @param [Hash] opts the optional parameters
|
|
633
633
|
# @return [Object]
|
|
@@ -636,8 +636,8 @@ module FactPulse
|
|
|
636
636
|
data
|
|
637
637
|
end
|
|
638
638
|
|
|
639
|
-
#
|
|
640
|
-
# Recycle
|
|
639
|
+
# Recycle an invoice (Supplier)
|
|
640
|
+
# Recycle an invoice with A_RECYCLER status by modifying routing data. **Required status**: A_RECYCLER **Modifiable fields**: - Recipient (`idStructureCPP`) - Service code - Engagement number **Use cases**: - Wrong recipient - Change of billing service - Update engagement number **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"idStructureCPP\": 67890, \"codeService\": \"SERVICE_01\", \"numeroEngagement\": \"ENG2024001\" } ``` **Note**: The invoice keeps its number and amounts, only routing fields change.
|
|
641
641
|
# @param request_body [Hash<String, Object>]
|
|
642
642
|
# @param [Hash] opts the optional parameters
|
|
643
643
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -694,28 +694,28 @@ module FactPulse
|
|
|
694
694
|
return data, status_code, headers
|
|
695
695
|
end
|
|
696
696
|
|
|
697
|
-
#
|
|
698
|
-
#
|
|
699
|
-
# @param
|
|
697
|
+
# Submit an invoice to Chorus Pro
|
|
698
|
+
# Submits an electronic invoice to a public structure via Chorus Pro. **Complete workflow**: 1. **Upload the Factur-X PDF** via `/transverses/ajouter-fichier` → retrieve `pieceJointeId` 2. **Get the structure ID** via `/structures/rechercher` or `/structures/obtenir-id-depuis-siret` 3. **Check mandatory parameters** via `/structures/consulter` 4. **Submit the invoice** with the `piece_jointe_principale_id` obtained in step 1 **Prerequisites**: 1. Have the recipient's `id_structure_cpp` (via `/structures/rechercher`) 2. Know the mandatory parameters (via `/structures/consulter`): - Service code if `code_service_doit_etre_renseigne=true` - Engagement number if `numero_ej_doit_etre_renseigne=true` 3. Have uploaded the Factur-X PDF (via `/transverses/ajouter-fichier`) **Expected format**: - `piece_jointe_principale_id`: ID returned by `/transverses/ajouter-fichier` - Amounts: Strings with 2 decimals (e.g., \"1250.50\") - Dates: ISO 8601 format (YYYY-MM-DD) **Returns**: - `identifiant_facture_cpp`: Chorus Pro ID of the created invoice - `numero_flux_depot`: Deposit tracking number **Possible statuses after submission**: - SOUMISE: Pending validation - VALIDEE: Validated by recipient - REJETEE: Rejected (data error or business refusal) - SUSPENDUE: Pending additional information **Note**: Use `/factures/consulter` to track status changes.
|
|
699
|
+
# @param submit_invoice_request [SubmitInvoiceRequest]
|
|
700
700
|
# @param [Hash] opts the optional parameters
|
|
701
|
-
# @return [
|
|
702
|
-
def soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(
|
|
703
|
-
data, _status_code, _headers = soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(
|
|
701
|
+
# @return [SubmitInvoiceResponse]
|
|
702
|
+
def soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(submit_invoice_request, opts = {})
|
|
703
|
+
data, _status_code, _headers = soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(submit_invoice_request, opts)
|
|
704
704
|
data
|
|
705
705
|
end
|
|
706
706
|
|
|
707
|
-
#
|
|
708
|
-
#
|
|
709
|
-
# @param
|
|
707
|
+
# Submit an invoice to Chorus Pro
|
|
708
|
+
# Submits an electronic invoice to a public structure via Chorus Pro. **Complete workflow**: 1. **Upload the Factur-X PDF** via `/transverses/ajouter-fichier` → retrieve `pieceJointeId` 2. **Get the structure ID** via `/structures/rechercher` or `/structures/obtenir-id-depuis-siret` 3. **Check mandatory parameters** via `/structures/consulter` 4. **Submit the invoice** with the `piece_jointe_principale_id` obtained in step 1 **Prerequisites**: 1. Have the recipient's `id_structure_cpp` (via `/structures/rechercher`) 2. Know the mandatory parameters (via `/structures/consulter`): - Service code if `code_service_doit_etre_renseigne=true` - Engagement number if `numero_ej_doit_etre_renseigne=true` 3. Have uploaded the Factur-X PDF (via `/transverses/ajouter-fichier`) **Expected format**: - `piece_jointe_principale_id`: ID returned by `/transverses/ajouter-fichier` - Amounts: Strings with 2 decimals (e.g., \"1250.50\") - Dates: ISO 8601 format (YYYY-MM-DD) **Returns**: - `identifiant_facture_cpp`: Chorus Pro ID of the created invoice - `numero_flux_depot`: Deposit tracking number **Possible statuses after submission**: - SOUMISE: Pending validation - VALIDEE: Validated by recipient - REJETEE: Rejected (data error or business refusal) - SUSPENDUE: Pending additional information **Note**: Use `/factures/consulter` to track status changes.
|
|
709
|
+
# @param submit_invoice_request [SubmitInvoiceRequest]
|
|
710
710
|
# @param [Hash] opts the optional parameters
|
|
711
|
-
# @return [Array<(
|
|
712
|
-
def soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(
|
|
711
|
+
# @return [Array<(SubmitInvoiceResponse, Integer, Hash)>] SubmitInvoiceResponse data, response status code and response headers
|
|
712
|
+
def soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(submit_invoice_request, opts = {})
|
|
713
713
|
if @api_client.config.debugging
|
|
714
714
|
@api_client.config.logger.debug 'Calling API: ChorusProApi.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post ...'
|
|
715
715
|
end
|
|
716
|
-
# verify the required parameter '
|
|
717
|
-
if @api_client.config.client_side_validation &&
|
|
718
|
-
fail ArgumentError, "Missing the required parameter '
|
|
716
|
+
# verify the required parameter 'submit_invoice_request' is set
|
|
717
|
+
if @api_client.config.client_side_validation && submit_invoice_request.nil?
|
|
718
|
+
fail ArgumentError, "Missing the required parameter 'submit_invoice_request' when calling ChorusProApi.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post"
|
|
719
719
|
end
|
|
720
720
|
# resource path
|
|
721
721
|
local_var_path = '/api/v1/chorus-pro/factures/soumettre'
|
|
@@ -737,10 +737,10 @@ module FactPulse
|
|
|
737
737
|
form_params = opts[:form_params] || {}
|
|
738
738
|
|
|
739
739
|
# http body (model)
|
|
740
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
740
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(submit_invoice_request)
|
|
741
741
|
|
|
742
742
|
# return_type
|
|
743
|
-
return_type = opts[:debug_return_type] || '
|
|
743
|
+
return_type = opts[:debug_return_type] || 'SubmitInvoiceResponse'
|
|
744
744
|
|
|
745
745
|
# auth_names
|
|
746
746
|
auth_names = opts[:debug_auth_names] || ['HTTPBearer']
|
|
@@ -762,8 +762,8 @@ module FactPulse
|
|
|
762
762
|
return data, status_code, headers
|
|
763
763
|
end
|
|
764
764
|
|
|
765
|
-
#
|
|
766
|
-
#
|
|
765
|
+
# Download a group of invoices
|
|
766
|
+
# Download one or more invoices (max 10 recommended) with their attachments. **Available formats**: - PDF: PDF file only - XML: XML file only - ZIP: Archive containing PDF + XML + attachments **Maximum size**: 120 MB per download **Example payload**: ```json { \"listeIdentifiantsFactureCPP\": [12345, 12346], \"inclurePiecesJointes\": true, \"formatFichier\": \"ZIP\" } ``` **Returns**: The file is base64-encoded in the `fichierBase64` field. **Note**: The `factureTelechargeeParDestinataire` flag is automatically updated.
|
|
767
767
|
# @param request_body [Hash<String, Object>]
|
|
768
768
|
# @param [Hash] opts the optional parameters
|
|
769
769
|
# @return [Object]
|
|
@@ -772,8 +772,8 @@ module FactPulse
|
|
|
772
772
|
data
|
|
773
773
|
end
|
|
774
774
|
|
|
775
|
-
#
|
|
776
|
-
#
|
|
775
|
+
# Download a group of invoices
|
|
776
|
+
# Download one or more invoices (max 10 recommended) with their attachments. **Available formats**: - PDF: PDF file only - XML: XML file only - ZIP: Archive containing PDF + XML + attachments **Maximum size**: 120 MB per download **Example payload**: ```json { \"listeIdentifiantsFactureCPP\": [12345, 12346], \"inclurePiecesJointes\": true, \"formatFichier\": \"ZIP\" } ``` **Returns**: The file is base64-encoded in the `fichierBase64` field. **Note**: The `factureTelechargeeParDestinataire` flag is automatically updated.
|
|
777
777
|
# @param request_body [Hash<String, Object>]
|
|
778
778
|
# @param [Hash] opts the optional parameters
|
|
779
779
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -830,8 +830,8 @@ module FactPulse
|
|
|
830
830
|
return data, status_code, headers
|
|
831
831
|
end
|
|
832
832
|
|
|
833
|
-
#
|
|
834
|
-
# Change
|
|
833
|
+
# Process a received invoice (Recipient)
|
|
834
|
+
# Change the status of a received invoice. **Possible statuses**: - MISE_A_DISPOSITION: Invoice accepted - SUSPENDUE: Pending additional information (reason required) - REJETEE: Invoice refused (reason required) - MANDATEE: Invoice mandated - MISE_EN_PAIEMENT: Invoice being paid - COMPTABILISEE: Invoice accounted - MISE_A_DISPOSITION_COMPTABLE: Made available to accounting - A_RECYCLER: To be recycled - COMPLETEE: Completed - SERVICE-FAIT: Service rendered - PRISE_EN_COMPTE_DESTINATAIRE: Acknowledged - TRANSMISE_MOA: Transmitted to MOA **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"nouveauStatut\": \"REJETEE\", \"motifRejet\": \"Duplicate invoice\", \"commentaire\": \"Invoice already received under reference ABC123\" } ``` **Rules**: - A reason is **required** for SUSPENDUE and REJETEE - Only certain statuses are allowed depending on the invoice's current status
|
|
835
835
|
# @param request_body [Hash<String, Object>]
|
|
836
836
|
# @param [Hash] opts the optional parameters
|
|
837
837
|
# @return [Object]
|
|
@@ -840,8 +840,8 @@ module FactPulse
|
|
|
840
840
|
data
|
|
841
841
|
end
|
|
842
842
|
|
|
843
|
-
#
|
|
844
|
-
# Change
|
|
843
|
+
# Process a received invoice (Recipient)
|
|
844
|
+
# Change the status of a received invoice. **Possible statuses**: - MISE_A_DISPOSITION: Invoice accepted - SUSPENDUE: Pending additional information (reason required) - REJETEE: Invoice refused (reason required) - MANDATEE: Invoice mandated - MISE_EN_PAIEMENT: Invoice being paid - COMPTABILISEE: Invoice accounted - MISE_A_DISPOSITION_COMPTABLE: Made available to accounting - A_RECYCLER: To be recycled - COMPLETEE: Completed - SERVICE-FAIT: Service rendered - PRISE_EN_COMPTE_DESTINATAIRE: Acknowledged - TRANSMISE_MOA: Transmitted to MOA **Example payload**: ```json { \"identifiantFactureCPP\": 12345, \"nouveauStatut\": \"REJETEE\", \"motifRejet\": \"Duplicate invoice\", \"commentaire\": \"Invoice already received under reference ABC123\" } ``` **Rules**: - A reason is **required** for SUSPENDUE and REJETEE - Only certain statuses are allowed depending on the invoice's current status
|
|
845
845
|
# @param request_body [Hash<String, Object>]
|
|
846
846
|
# @param [Hash] opts the optional parameters
|
|
847
847
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -898,7 +898,7 @@ module FactPulse
|
|
|
898
898
|
return data, status_code, headers
|
|
899
899
|
end
|
|
900
900
|
|
|
901
|
-
#
|
|
901
|
+
# Consult an invoice (Validator)
|
|
902
902
|
# @param request_body [Hash<String, Object>]
|
|
903
903
|
# @param [Hash] opts the optional parameters
|
|
904
904
|
# @return [Object]
|
|
@@ -907,7 +907,7 @@ module FactPulse
|
|
|
907
907
|
data
|
|
908
908
|
end
|
|
909
909
|
|
|
910
|
-
#
|
|
910
|
+
# Consult an invoice (Validator)
|
|
911
911
|
# @param request_body [Hash<String, Object>]
|
|
912
912
|
# @param [Hash] opts the optional parameters
|
|
913
913
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -964,8 +964,8 @@ module FactPulse
|
|
|
964
964
|
return data, status_code, headers
|
|
965
965
|
end
|
|
966
966
|
|
|
967
|
-
#
|
|
968
|
-
#
|
|
967
|
+
# Search invoices to validate (Validator)
|
|
968
|
+
# Search invoices pending validation by the connected validator. **Role**: Validator in the internal validation workflow. **Filters**: Dates, structure, service, etc.
|
|
969
969
|
# @param request_body [Hash<String, Object>]
|
|
970
970
|
# @param [Hash] opts the optional parameters
|
|
971
971
|
# @return [Object]
|
|
@@ -974,8 +974,8 @@ module FactPulse
|
|
|
974
974
|
data
|
|
975
975
|
end
|
|
976
976
|
|
|
977
|
-
#
|
|
978
|
-
#
|
|
977
|
+
# Search invoices to validate (Validator)
|
|
978
|
+
# Search invoices pending validation by the connected validator. **Role**: Validator in the internal validation workflow. **Filters**: Dates, structure, service, etc.
|
|
979
979
|
# @param request_body [Hash<String, Object>]
|
|
980
980
|
# @param [Hash] opts the optional parameters
|
|
981
981
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
@@ -1032,8 +1032,8 @@ module FactPulse
|
|
|
1032
1032
|
return data, status_code, headers
|
|
1033
1033
|
end
|
|
1034
1034
|
|
|
1035
|
-
#
|
|
1036
|
-
#
|
|
1035
|
+
# Validate or reject an invoice (Validator)
|
|
1036
|
+
# Validate or reject an invoice pending validation. **Actions**: - Validate: The invoice moves to the next status in the workflow - Reject: The invoice is rejected (reason required)
|
|
1037
1037
|
# @param request_body [Hash<String, Object>]
|
|
1038
1038
|
# @param [Hash] opts the optional parameters
|
|
1039
1039
|
# @return [Object]
|
|
@@ -1042,8 +1042,8 @@ module FactPulse
|
|
|
1042
1042
|
data
|
|
1043
1043
|
end
|
|
1044
1044
|
|
|
1045
|
-
#
|
|
1046
|
-
#
|
|
1045
|
+
# Validate or reject an invoice (Validator)
|
|
1046
|
+
# Validate or reject an invoice pending validation. **Actions**: - Validate: The invoice moves to the next status in the workflow - Reject: The invoice is rejected (reason required)
|
|
1047
1047
|
# @param request_body [Hash<String, Object>]
|
|
1048
1048
|
# @param [Hash] opts the optional parameters
|
|
1049
1049
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|