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
data/docs/ChorusProApi.md
CHANGED
|
@@ -4,31 +4,31 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post**](ChorusProApi.md#ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post) | **POST** /api/v1/chorus-pro/transverses/ajouter-fichier |
|
|
8
|
-
| [**completer_facture_api_v1_chorus_pro_factures_completer_post**](ChorusProApi.md#completer_facture_api_v1_chorus_pro_factures_completer_post) | **POST** /api/v1/chorus-pro/factures/completer |
|
|
9
|
-
| [**consulter_facture_api_v1_chorus_pro_factures_consulter_post**](ChorusProApi.md#consulter_facture_api_v1_chorus_pro_factures_consulter_post) | **POST** /api/v1/chorus-pro/factures/consulter |
|
|
10
|
-
| [**consulter_structure_api_v1_chorus_pro_structures_consulter_post**](ChorusProApi.md#consulter_structure_api_v1_chorus_pro_structures_consulter_post) | **POST** /api/v1/chorus-pro/structures/consulter |
|
|
11
|
-
| [**lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get**](ChorusProApi.md#lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get) | **GET** /api/v1/chorus-pro/structures/{id_structure_cpp}/services |
|
|
12
|
-
| [**obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post**](ChorusProApi.md#obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post) | **POST** /api/v1/chorus-pro/structures/obtenir-id-depuis-siret |
|
|
13
|
-
| [**rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post**](ChorusProApi.md#rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post) | **POST** /api/v1/chorus-pro/factures/rechercher-destinataire |
|
|
14
|
-
| [**rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post**](ChorusProApi.md#rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post) | **POST** /api/v1/chorus-pro/factures/rechercher-fournisseur |
|
|
15
|
-
| [**rechercher_structures_api_v1_chorus_pro_structures_rechercher_post**](ChorusProApi.md#rechercher_structures_api_v1_chorus_pro_structures_rechercher_post) | **POST** /api/v1/chorus-pro/structures/rechercher |
|
|
16
|
-
| [**recycler_facture_api_v1_chorus_pro_factures_recycler_post**](ChorusProApi.md#recycler_facture_api_v1_chorus_pro_factures_recycler_post) | **POST** /api/v1/chorus-pro/factures/recycler |
|
|
17
|
-
| [**soumettre_facture_api_v1_chorus_pro_factures_soumettre_post**](ChorusProApi.md#soumettre_facture_api_v1_chorus_pro_factures_soumettre_post) | **POST** /api/v1/chorus-pro/factures/soumettre |
|
|
18
|
-
| [**telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post**](ChorusProApi.md#telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post) | **POST** /api/v1/chorus-pro/factures/telecharger-groupe |
|
|
19
|
-
| [**traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post**](ChorusProApi.md#traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post) | **POST** /api/v1/chorus-pro/factures/traiter-facture-recue |
|
|
20
|
-
| [**valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post**](ChorusProApi.md#valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post) | **POST** /api/v1/chorus-pro/factures/valideur/consulter |
|
|
21
|
-
| [**valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post**](ChorusProApi.md#valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post) | **POST** /api/v1/chorus-pro/factures/valideur/rechercher |
|
|
22
|
-
| [**valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post**](ChorusProApi.md#valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post) | **POST** /api/v1/chorus-pro/factures/valideur/traiter |
|
|
7
|
+
| [**ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post**](ChorusProApi.md#ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post) | **POST** /api/v1/chorus-pro/transverses/ajouter-fichier | Add an attachment |
|
|
8
|
+
| [**completer_facture_api_v1_chorus_pro_factures_completer_post**](ChorusProApi.md#completer_facture_api_v1_chorus_pro_factures_completer_post) | **POST** /api/v1/chorus-pro/factures/completer | Complete a suspended invoice (Supplier) |
|
|
9
|
+
| [**consulter_facture_api_v1_chorus_pro_factures_consulter_post**](ChorusProApi.md#consulter_facture_api_v1_chorus_pro_factures_consulter_post) | **POST** /api/v1/chorus-pro/factures/consulter | Consult invoice status |
|
|
10
|
+
| [**consulter_structure_api_v1_chorus_pro_structures_consulter_post**](ChorusProApi.md#consulter_structure_api_v1_chorus_pro_structures_consulter_post) | **POST** /api/v1/chorus-pro/structures/consulter | Consult structure details |
|
|
11
|
+
| [**lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get**](ChorusProApi.md#lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get) | **GET** /api/v1/chorus-pro/structures/{id_structure_cpp}/services | List structure services |
|
|
12
|
+
| [**obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post**](ChorusProApi.md#obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post) | **POST** /api/v1/chorus-pro/structures/obtenir-id-depuis-siret | Utility: Get Chorus Pro ID from SIRET |
|
|
13
|
+
| [**rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post**](ChorusProApi.md#rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post) | **POST** /api/v1/chorus-pro/factures/rechercher-destinataire | Search received invoices (Recipient) |
|
|
14
|
+
| [**rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post**](ChorusProApi.md#rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post) | **POST** /api/v1/chorus-pro/factures/rechercher-fournisseur | Search issued invoices (Supplier) |
|
|
15
|
+
| [**rechercher_structures_api_v1_chorus_pro_structures_rechercher_post**](ChorusProApi.md#rechercher_structures_api_v1_chorus_pro_structures_rechercher_post) | **POST** /api/v1/chorus-pro/structures/rechercher | Search Chorus Pro structures |
|
|
16
|
+
| [**recycler_facture_api_v1_chorus_pro_factures_recycler_post**](ChorusProApi.md#recycler_facture_api_v1_chorus_pro_factures_recycler_post) | **POST** /api/v1/chorus-pro/factures/recycler | Recycle an invoice (Supplier) |
|
|
17
|
+
| [**soumettre_facture_api_v1_chorus_pro_factures_soumettre_post**](ChorusProApi.md#soumettre_facture_api_v1_chorus_pro_factures_soumettre_post) | **POST** /api/v1/chorus-pro/factures/soumettre | Submit an invoice to Chorus Pro |
|
|
18
|
+
| [**telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post**](ChorusProApi.md#telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post) | **POST** /api/v1/chorus-pro/factures/telecharger-groupe | Download a group of invoices |
|
|
19
|
+
| [**traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post**](ChorusProApi.md#traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post) | **POST** /api/v1/chorus-pro/factures/traiter-facture-recue | Process a received invoice (Recipient) |
|
|
20
|
+
| [**valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post**](ChorusProApi.md#valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post) | **POST** /api/v1/chorus-pro/factures/valideur/consulter | Consult an invoice (Validator) |
|
|
21
|
+
| [**valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post**](ChorusProApi.md#valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post) | **POST** /api/v1/chorus-pro/factures/valideur/rechercher | Search invoices to validate (Validator) |
|
|
22
|
+
| [**valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post**](ChorusProApi.md#valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post) | **POST** /api/v1/chorus-pro/factures/valideur/traiter | Validate or reject an invoice (Validator) |
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
## ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post
|
|
26
26
|
|
|
27
27
|
> Object ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post(request_body)
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
Add an attachment
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
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.
|
|
32
32
|
|
|
33
33
|
### Examples
|
|
34
34
|
|
|
@@ -45,7 +45,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
45
45
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
46
46
|
|
|
47
47
|
begin
|
|
48
|
-
#
|
|
48
|
+
# Add an attachment
|
|
49
49
|
result = api_instance.ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post(request_body)
|
|
50
50
|
p result
|
|
51
51
|
rescue FactPulse::ApiError => e
|
|
@@ -61,7 +61,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
61
61
|
|
|
62
62
|
```ruby
|
|
63
63
|
begin
|
|
64
|
-
#
|
|
64
|
+
# Add an attachment
|
|
65
65
|
data, status_code, headers = api_instance.ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info(request_body)
|
|
66
66
|
p status_code # => 2xx
|
|
67
67
|
p headers # => { ... }
|
|
@@ -95,9 +95,9 @@ end
|
|
|
95
95
|
|
|
96
96
|
> Object completer_facture_api_v1_chorus_pro_factures_completer_post(request_body)
|
|
97
97
|
|
|
98
|
-
|
|
98
|
+
Complete a suspended invoice (Supplier)
|
|
99
99
|
|
|
100
|
-
|
|
100
|
+
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.
|
|
101
101
|
|
|
102
102
|
### Examples
|
|
103
103
|
|
|
@@ -114,7 +114,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
114
114
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
115
115
|
|
|
116
116
|
begin
|
|
117
|
-
#
|
|
117
|
+
# Complete a suspended invoice (Supplier)
|
|
118
118
|
result = api_instance.completer_facture_api_v1_chorus_pro_factures_completer_post(request_body)
|
|
119
119
|
p result
|
|
120
120
|
rescue FactPulse::ApiError => e
|
|
@@ -130,7 +130,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
130
130
|
|
|
131
131
|
```ruby
|
|
132
132
|
begin
|
|
133
|
-
#
|
|
133
|
+
# Complete a suspended invoice (Supplier)
|
|
134
134
|
data, status_code, headers = api_instance.completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info(request_body)
|
|
135
135
|
p status_code # => 2xx
|
|
136
136
|
p headers # => { ... }
|
|
@@ -162,11 +162,11 @@ end
|
|
|
162
162
|
|
|
163
163
|
## consulter_facture_api_v1_chorus_pro_factures_consulter_post
|
|
164
164
|
|
|
165
|
-
> <
|
|
165
|
+
> <GetInvoiceResponse> consulter_facture_api_v1_chorus_pro_factures_consulter_post(get_invoice_request)
|
|
166
166
|
|
|
167
|
-
|
|
167
|
+
Consult invoice status
|
|
168
168
|
|
|
169
|
-
|
|
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
170
|
|
|
171
171
|
### Examples
|
|
172
172
|
|
|
@@ -180,11 +180,11 @@ FactPulse.configure do |config|
|
|
|
180
180
|
end
|
|
181
181
|
|
|
182
182
|
api_instance = FactPulse::ChorusProApi.new
|
|
183
|
-
|
|
183
|
+
get_invoice_request = FactPulse::GetInvoiceRequest.new({chorus_invoice_id: 37}) # GetInvoiceRequest |
|
|
184
184
|
|
|
185
185
|
begin
|
|
186
|
-
#
|
|
187
|
-
result = api_instance.consulter_facture_api_v1_chorus_pro_factures_consulter_post(
|
|
186
|
+
# Consult invoice status
|
|
187
|
+
result = api_instance.consulter_facture_api_v1_chorus_pro_factures_consulter_post(get_invoice_request)
|
|
188
188
|
p result
|
|
189
189
|
rescue FactPulse::ApiError => e
|
|
190
190
|
puts "Error when calling ChorusProApi->consulter_facture_api_v1_chorus_pro_factures_consulter_post: #{e}"
|
|
@@ -195,15 +195,15 @@ end
|
|
|
195
195
|
|
|
196
196
|
This returns an Array which contains the response data, status code and headers.
|
|
197
197
|
|
|
198
|
-
> <Array(<
|
|
198
|
+
> <Array(<GetInvoiceResponse>, Integer, Hash)> consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(get_invoice_request)
|
|
199
199
|
|
|
200
200
|
```ruby
|
|
201
201
|
begin
|
|
202
|
-
#
|
|
203
|
-
data, status_code, headers = api_instance.consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(
|
|
202
|
+
# Consult invoice status
|
|
203
|
+
data, status_code, headers = api_instance.consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(get_invoice_request)
|
|
204
204
|
p status_code # => 2xx
|
|
205
205
|
p headers # => { ... }
|
|
206
|
-
p data # => <
|
|
206
|
+
p data # => <GetInvoiceResponse>
|
|
207
207
|
rescue FactPulse::ApiError => e
|
|
208
208
|
puts "Error when calling ChorusProApi->consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info: #{e}"
|
|
209
209
|
end
|
|
@@ -213,11 +213,11 @@ end
|
|
|
213
213
|
|
|
214
214
|
| Name | Type | Description | Notes |
|
|
215
215
|
| ---- | ---- | ----------- | ----- |
|
|
216
|
-
| **
|
|
216
|
+
| **get_invoice_request** | [**GetInvoiceRequest**](GetInvoiceRequest.md) | | |
|
|
217
217
|
|
|
218
218
|
### Return type
|
|
219
219
|
|
|
220
|
-
[**
|
|
220
|
+
[**GetInvoiceResponse**](GetInvoiceResponse.md)
|
|
221
221
|
|
|
222
222
|
### Authorization
|
|
223
223
|
|
|
@@ -231,11 +231,11 @@ end
|
|
|
231
231
|
|
|
232
232
|
## consulter_structure_api_v1_chorus_pro_structures_consulter_post
|
|
233
233
|
|
|
234
|
-
> <
|
|
234
|
+
> <GetStructureResponse> consulter_structure_api_v1_chorus_pro_structures_consulter_post(get_structure_request)
|
|
235
235
|
|
|
236
|
-
|
|
236
|
+
Consult structure details
|
|
237
237
|
|
|
238
|
-
|
|
238
|
+
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.
|
|
239
239
|
|
|
240
240
|
### Examples
|
|
241
241
|
|
|
@@ -249,11 +249,11 @@ FactPulse.configure do |config|
|
|
|
249
249
|
end
|
|
250
250
|
|
|
251
251
|
api_instance = FactPulse::ChorusProApi.new
|
|
252
|
-
|
|
252
|
+
get_structure_request = FactPulse::GetStructureRequest.new({structure_id: 37}) # GetStructureRequest |
|
|
253
253
|
|
|
254
254
|
begin
|
|
255
|
-
#
|
|
256
|
-
result = api_instance.consulter_structure_api_v1_chorus_pro_structures_consulter_post(
|
|
255
|
+
# Consult structure details
|
|
256
|
+
result = api_instance.consulter_structure_api_v1_chorus_pro_structures_consulter_post(get_structure_request)
|
|
257
257
|
p result
|
|
258
258
|
rescue FactPulse::ApiError => e
|
|
259
259
|
puts "Error when calling ChorusProApi->consulter_structure_api_v1_chorus_pro_structures_consulter_post: #{e}"
|
|
@@ -264,15 +264,15 @@ end
|
|
|
264
264
|
|
|
265
265
|
This returns an Array which contains the response data, status code and headers.
|
|
266
266
|
|
|
267
|
-
> <Array(<
|
|
267
|
+
> <Array(<GetStructureResponse>, Integer, Hash)> consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(get_structure_request)
|
|
268
268
|
|
|
269
269
|
```ruby
|
|
270
270
|
begin
|
|
271
|
-
#
|
|
272
|
-
data, status_code, headers = api_instance.consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(
|
|
271
|
+
# Consult structure details
|
|
272
|
+
data, status_code, headers = api_instance.consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(get_structure_request)
|
|
273
273
|
p status_code # => 2xx
|
|
274
274
|
p headers # => { ... }
|
|
275
|
-
p data # => <
|
|
275
|
+
p data # => <GetStructureResponse>
|
|
276
276
|
rescue FactPulse::ApiError => e
|
|
277
277
|
puts "Error when calling ChorusProApi->consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info: #{e}"
|
|
278
278
|
end
|
|
@@ -282,11 +282,11 @@ end
|
|
|
282
282
|
|
|
283
283
|
| Name | Type | Description | Notes |
|
|
284
284
|
| ---- | ---- | ----------- | ----- |
|
|
285
|
-
| **
|
|
285
|
+
| **get_structure_request** | [**GetStructureRequest**](GetStructureRequest.md) | | |
|
|
286
286
|
|
|
287
287
|
### Return type
|
|
288
288
|
|
|
289
|
-
[**
|
|
289
|
+
[**GetStructureResponse**](GetStructureResponse.md)
|
|
290
290
|
|
|
291
291
|
### Authorization
|
|
292
292
|
|
|
@@ -300,11 +300,11 @@ end
|
|
|
300
300
|
|
|
301
301
|
## lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get
|
|
302
302
|
|
|
303
|
-
> <
|
|
303
|
+
> <SearchServicesResponse> lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get(id_structure_cpp)
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
List structure services
|
|
306
306
|
|
|
307
|
-
|
|
307
|
+
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)
|
|
308
308
|
|
|
309
309
|
### Examples
|
|
310
310
|
|
|
@@ -321,7 +321,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
321
321
|
id_structure_cpp = 56 # Integer |
|
|
322
322
|
|
|
323
323
|
begin
|
|
324
|
-
#
|
|
324
|
+
# List structure services
|
|
325
325
|
result = api_instance.lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get(id_structure_cpp)
|
|
326
326
|
p result
|
|
327
327
|
rescue FactPulse::ApiError => e
|
|
@@ -333,15 +333,15 @@ end
|
|
|
333
333
|
|
|
334
334
|
This returns an Array which contains the response data, status code and headers.
|
|
335
335
|
|
|
336
|
-
> <Array(<
|
|
336
|
+
> <Array(<SearchServicesResponse>, Integer, Hash)> lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info(id_structure_cpp)
|
|
337
337
|
|
|
338
338
|
```ruby
|
|
339
339
|
begin
|
|
340
|
-
#
|
|
340
|
+
# List structure services
|
|
341
341
|
data, status_code, headers = api_instance.lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info(id_structure_cpp)
|
|
342
342
|
p status_code # => 2xx
|
|
343
343
|
p headers # => { ... }
|
|
344
|
-
p data # => <
|
|
344
|
+
p data # => <SearchServicesResponse>
|
|
345
345
|
rescue FactPulse::ApiError => e
|
|
346
346
|
puts "Error when calling ChorusProApi->lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info: #{e}"
|
|
347
347
|
end
|
|
@@ -355,7 +355,7 @@ end
|
|
|
355
355
|
|
|
356
356
|
### Return type
|
|
357
357
|
|
|
358
|
-
[**
|
|
358
|
+
[**SearchServicesResponse**](SearchServicesResponse.md)
|
|
359
359
|
|
|
360
360
|
### Authorization
|
|
361
361
|
|
|
@@ -369,11 +369,11 @@ end
|
|
|
369
369
|
|
|
370
370
|
## obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post
|
|
371
371
|
|
|
372
|
-
> <
|
|
372
|
+
> <GetChorusProIdResponse> obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(get_chorus_pro_id_request)
|
|
373
373
|
|
|
374
|
-
|
|
374
|
+
Utility: Get Chorus Pro ID from SIRET
|
|
375
375
|
|
|
376
|
-
**
|
|
376
|
+
**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.
|
|
377
377
|
|
|
378
378
|
### Examples
|
|
379
379
|
|
|
@@ -387,11 +387,11 @@ FactPulse.configure do |config|
|
|
|
387
387
|
end
|
|
388
388
|
|
|
389
389
|
api_instance = FactPulse::ChorusProApi.new
|
|
390
|
-
|
|
390
|
+
get_chorus_pro_id_request = FactPulse::GetChorusProIdRequest.new({siret: 'siret_example'}) # GetChorusProIdRequest |
|
|
391
391
|
|
|
392
392
|
begin
|
|
393
|
-
#
|
|
394
|
-
result = api_instance.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(
|
|
393
|
+
# Utility: Get Chorus Pro ID from SIRET
|
|
394
|
+
result = api_instance.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(get_chorus_pro_id_request)
|
|
395
395
|
p result
|
|
396
396
|
rescue FactPulse::ApiError => e
|
|
397
397
|
puts "Error when calling ChorusProApi->obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post: #{e}"
|
|
@@ -402,15 +402,15 @@ end
|
|
|
402
402
|
|
|
403
403
|
This returns an Array which contains the response data, status code and headers.
|
|
404
404
|
|
|
405
|
-
> <Array(<
|
|
405
|
+
> <Array(<GetChorusProIdResponse>, Integer, Hash)> obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(get_chorus_pro_id_request)
|
|
406
406
|
|
|
407
407
|
```ruby
|
|
408
408
|
begin
|
|
409
|
-
#
|
|
410
|
-
data, status_code, headers = api_instance.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(
|
|
409
|
+
# Utility: Get Chorus Pro ID from SIRET
|
|
410
|
+
data, status_code, headers = api_instance.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(get_chorus_pro_id_request)
|
|
411
411
|
p status_code # => 2xx
|
|
412
412
|
p headers # => { ... }
|
|
413
|
-
p data # => <
|
|
413
|
+
p data # => <GetChorusProIdResponse>
|
|
414
414
|
rescue FactPulse::ApiError => e
|
|
415
415
|
puts "Error when calling ChorusProApi->obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info: #{e}"
|
|
416
416
|
end
|
|
@@ -420,11 +420,11 @@ end
|
|
|
420
420
|
|
|
421
421
|
| Name | Type | Description | Notes |
|
|
422
422
|
| ---- | ---- | ----------- | ----- |
|
|
423
|
-
| **
|
|
423
|
+
| **get_chorus_pro_id_request** | [**GetChorusProIdRequest**](GetChorusProIdRequest.md) | | |
|
|
424
424
|
|
|
425
425
|
### Return type
|
|
426
426
|
|
|
427
|
-
[**
|
|
427
|
+
[**GetChorusProIdResponse**](GetChorusProIdResponse.md)
|
|
428
428
|
|
|
429
429
|
### Authorization
|
|
430
430
|
|
|
@@ -440,9 +440,9 @@ end
|
|
|
440
440
|
|
|
441
441
|
> Object rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post(request_body)
|
|
442
442
|
|
|
443
|
-
|
|
443
|
+
Search received invoices (Recipient)
|
|
444
444
|
|
|
445
|
-
|
|
445
|
+
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.
|
|
446
446
|
|
|
447
447
|
### Examples
|
|
448
448
|
|
|
@@ -459,7 +459,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
459
459
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
460
460
|
|
|
461
461
|
begin
|
|
462
|
-
#
|
|
462
|
+
# Search received invoices (Recipient)
|
|
463
463
|
result = api_instance.rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post(request_body)
|
|
464
464
|
p result
|
|
465
465
|
rescue FactPulse::ApiError => e
|
|
@@ -475,7 +475,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
475
475
|
|
|
476
476
|
```ruby
|
|
477
477
|
begin
|
|
478
|
-
#
|
|
478
|
+
# Search received invoices (Recipient)
|
|
479
479
|
data, status_code, headers = api_instance.rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info(request_body)
|
|
480
480
|
p status_code # => 2xx
|
|
481
481
|
p headers # => { ... }
|
|
@@ -509,9 +509,9 @@ end
|
|
|
509
509
|
|
|
510
510
|
> Object rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post(request_body)
|
|
511
511
|
|
|
512
|
-
|
|
512
|
+
Search issued invoices (Supplier)
|
|
513
513
|
|
|
514
|
-
|
|
514
|
+
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
|
|
515
515
|
|
|
516
516
|
### Examples
|
|
517
517
|
|
|
@@ -528,7 +528,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
528
528
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
529
529
|
|
|
530
530
|
begin
|
|
531
|
-
#
|
|
531
|
+
# Search issued invoices (Supplier)
|
|
532
532
|
result = api_instance.rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post(request_body)
|
|
533
533
|
p result
|
|
534
534
|
rescue FactPulse::ApiError => e
|
|
@@ -544,7 +544,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
544
544
|
|
|
545
545
|
```ruby
|
|
546
546
|
begin
|
|
547
|
-
#
|
|
547
|
+
# Search issued invoices (Supplier)
|
|
548
548
|
data, status_code, headers = api_instance.rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info(request_body)
|
|
549
549
|
p status_code # => 2xx
|
|
550
550
|
p headers # => { ... }
|
|
@@ -576,11 +576,11 @@ end
|
|
|
576
576
|
|
|
577
577
|
## rechercher_structures_api_v1_chorus_pro_structures_rechercher_post
|
|
578
578
|
|
|
579
|
-
> <
|
|
579
|
+
> <SearchStructureResponse> rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(search_structure_request)
|
|
580
580
|
|
|
581
|
-
|
|
581
|
+
Search Chorus Pro structures
|
|
582
582
|
|
|
583
|
-
|
|
583
|
+
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`.
|
|
584
584
|
|
|
585
585
|
### Examples
|
|
586
586
|
|
|
@@ -594,11 +594,11 @@ FactPulse.configure do |config|
|
|
|
594
594
|
end
|
|
595
595
|
|
|
596
596
|
api_instance = FactPulse::ChorusProApi.new
|
|
597
|
-
|
|
597
|
+
search_structure_request = FactPulse::SearchStructureRequest.new # SearchStructureRequest |
|
|
598
598
|
|
|
599
599
|
begin
|
|
600
|
-
#
|
|
601
|
-
result = api_instance.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(
|
|
600
|
+
# Search Chorus Pro structures
|
|
601
|
+
result = api_instance.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(search_structure_request)
|
|
602
602
|
p result
|
|
603
603
|
rescue FactPulse::ApiError => e
|
|
604
604
|
puts "Error when calling ChorusProApi->rechercher_structures_api_v1_chorus_pro_structures_rechercher_post: #{e}"
|
|
@@ -609,15 +609,15 @@ end
|
|
|
609
609
|
|
|
610
610
|
This returns an Array which contains the response data, status code and headers.
|
|
611
611
|
|
|
612
|
-
> <Array(<
|
|
612
|
+
> <Array(<SearchStructureResponse>, Integer, Hash)> rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(search_structure_request)
|
|
613
613
|
|
|
614
614
|
```ruby
|
|
615
615
|
begin
|
|
616
|
-
#
|
|
617
|
-
data, status_code, headers = api_instance.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(
|
|
616
|
+
# Search Chorus Pro structures
|
|
617
|
+
data, status_code, headers = api_instance.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(search_structure_request)
|
|
618
618
|
p status_code # => 2xx
|
|
619
619
|
p headers # => { ... }
|
|
620
|
-
p data # => <
|
|
620
|
+
p data # => <SearchStructureResponse>
|
|
621
621
|
rescue FactPulse::ApiError => e
|
|
622
622
|
puts "Error when calling ChorusProApi->rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info: #{e}"
|
|
623
623
|
end
|
|
@@ -627,11 +627,11 @@ end
|
|
|
627
627
|
|
|
628
628
|
| Name | Type | Description | Notes |
|
|
629
629
|
| ---- | ---- | ----------- | ----- |
|
|
630
|
-
| **
|
|
630
|
+
| **search_structure_request** | [**SearchStructureRequest**](SearchStructureRequest.md) | | |
|
|
631
631
|
|
|
632
632
|
### Return type
|
|
633
633
|
|
|
634
|
-
[**
|
|
634
|
+
[**SearchStructureResponse**](SearchStructureResponse.md)
|
|
635
635
|
|
|
636
636
|
### Authorization
|
|
637
637
|
|
|
@@ -647,9 +647,9 @@ end
|
|
|
647
647
|
|
|
648
648
|
> Object recycler_facture_api_v1_chorus_pro_factures_recycler_post(request_body)
|
|
649
649
|
|
|
650
|
-
|
|
650
|
+
Recycle an invoice (Supplier)
|
|
651
651
|
|
|
652
|
-
Recycle
|
|
652
|
+
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.
|
|
653
653
|
|
|
654
654
|
### Examples
|
|
655
655
|
|
|
@@ -666,7 +666,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
666
666
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
667
667
|
|
|
668
668
|
begin
|
|
669
|
-
#
|
|
669
|
+
# Recycle an invoice (Supplier)
|
|
670
670
|
result = api_instance.recycler_facture_api_v1_chorus_pro_factures_recycler_post(request_body)
|
|
671
671
|
p result
|
|
672
672
|
rescue FactPulse::ApiError => e
|
|
@@ -682,7 +682,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
682
682
|
|
|
683
683
|
```ruby
|
|
684
684
|
begin
|
|
685
|
-
#
|
|
685
|
+
# Recycle an invoice (Supplier)
|
|
686
686
|
data, status_code, headers = api_instance.recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info(request_body)
|
|
687
687
|
p status_code # => 2xx
|
|
688
688
|
p headers # => { ... }
|
|
@@ -714,11 +714,11 @@ end
|
|
|
714
714
|
|
|
715
715
|
## soumettre_facture_api_v1_chorus_pro_factures_soumettre_post
|
|
716
716
|
|
|
717
|
-
> <
|
|
717
|
+
> <SubmitInvoiceResponse> soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(submit_invoice_request)
|
|
718
718
|
|
|
719
|
-
|
|
719
|
+
Submit an invoice to Chorus Pro
|
|
720
720
|
|
|
721
|
-
|
|
721
|
+
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.
|
|
722
722
|
|
|
723
723
|
### Examples
|
|
724
724
|
|
|
@@ -732,11 +732,11 @@ FactPulse.configure do |config|
|
|
|
732
732
|
end
|
|
733
733
|
|
|
734
734
|
api_instance = FactPulse::ChorusProApi.new
|
|
735
|
-
|
|
735
|
+
submit_invoice_request = FactPulse::SubmitInvoiceRequest.new({invoice_number: 'invoice_number_example', invoice_date: 'invoice_date_example', structure_id: 37, total_net_amount: FactPulse::TotalNetAmount.new, vat_amount: FactPulse::VatAmount.new, total_gross_amount: FactPulse::TotalGrossAmount.new}) # SubmitInvoiceRequest |
|
|
736
736
|
|
|
737
737
|
begin
|
|
738
|
-
#
|
|
739
|
-
result = api_instance.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(
|
|
738
|
+
# Submit an invoice to Chorus Pro
|
|
739
|
+
result = api_instance.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(submit_invoice_request)
|
|
740
740
|
p result
|
|
741
741
|
rescue FactPulse::ApiError => e
|
|
742
742
|
puts "Error when calling ChorusProApi->soumettre_facture_api_v1_chorus_pro_factures_soumettre_post: #{e}"
|
|
@@ -747,15 +747,15 @@ end
|
|
|
747
747
|
|
|
748
748
|
This returns an Array which contains the response data, status code and headers.
|
|
749
749
|
|
|
750
|
-
> <Array(<
|
|
750
|
+
> <Array(<SubmitInvoiceResponse>, Integer, Hash)> soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(submit_invoice_request)
|
|
751
751
|
|
|
752
752
|
```ruby
|
|
753
753
|
begin
|
|
754
|
-
#
|
|
755
|
-
data, status_code, headers = api_instance.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(
|
|
754
|
+
# Submit an invoice to Chorus Pro
|
|
755
|
+
data, status_code, headers = api_instance.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(submit_invoice_request)
|
|
756
756
|
p status_code # => 2xx
|
|
757
757
|
p headers # => { ... }
|
|
758
|
-
p data # => <
|
|
758
|
+
p data # => <SubmitInvoiceResponse>
|
|
759
759
|
rescue FactPulse::ApiError => e
|
|
760
760
|
puts "Error when calling ChorusProApi->soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info: #{e}"
|
|
761
761
|
end
|
|
@@ -765,11 +765,11 @@ end
|
|
|
765
765
|
|
|
766
766
|
| Name | Type | Description | Notes |
|
|
767
767
|
| ---- | ---- | ----------- | ----- |
|
|
768
|
-
| **
|
|
768
|
+
| **submit_invoice_request** | [**SubmitInvoiceRequest**](SubmitInvoiceRequest.md) | | |
|
|
769
769
|
|
|
770
770
|
### Return type
|
|
771
771
|
|
|
772
|
-
[**
|
|
772
|
+
[**SubmitInvoiceResponse**](SubmitInvoiceResponse.md)
|
|
773
773
|
|
|
774
774
|
### Authorization
|
|
775
775
|
|
|
@@ -785,9 +785,9 @@ end
|
|
|
785
785
|
|
|
786
786
|
> Object telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post(request_body)
|
|
787
787
|
|
|
788
|
-
|
|
788
|
+
Download a group of invoices
|
|
789
789
|
|
|
790
|
-
|
|
790
|
+
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.
|
|
791
791
|
|
|
792
792
|
### Examples
|
|
793
793
|
|
|
@@ -804,7 +804,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
804
804
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
805
805
|
|
|
806
806
|
begin
|
|
807
|
-
#
|
|
807
|
+
# Download a group of invoices
|
|
808
808
|
result = api_instance.telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post(request_body)
|
|
809
809
|
p result
|
|
810
810
|
rescue FactPulse::ApiError => e
|
|
@@ -820,7 +820,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
820
820
|
|
|
821
821
|
```ruby
|
|
822
822
|
begin
|
|
823
|
-
#
|
|
823
|
+
# Download a group of invoices
|
|
824
824
|
data, status_code, headers = api_instance.telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info(request_body)
|
|
825
825
|
p status_code # => 2xx
|
|
826
826
|
p headers # => { ... }
|
|
@@ -854,9 +854,9 @@ end
|
|
|
854
854
|
|
|
855
855
|
> Object traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post(request_body)
|
|
856
856
|
|
|
857
|
-
|
|
857
|
+
Process a received invoice (Recipient)
|
|
858
858
|
|
|
859
|
-
Change
|
|
859
|
+
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
|
|
860
860
|
|
|
861
861
|
### Examples
|
|
862
862
|
|
|
@@ -873,7 +873,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
873
873
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
874
874
|
|
|
875
875
|
begin
|
|
876
|
-
#
|
|
876
|
+
# Process a received invoice (Recipient)
|
|
877
877
|
result = api_instance.traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post(request_body)
|
|
878
878
|
p result
|
|
879
879
|
rescue FactPulse::ApiError => e
|
|
@@ -889,7 +889,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
889
889
|
|
|
890
890
|
```ruby
|
|
891
891
|
begin
|
|
892
|
-
#
|
|
892
|
+
# Process a received invoice (Recipient)
|
|
893
893
|
data, status_code, headers = api_instance.traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post_with_http_info(request_body)
|
|
894
894
|
p status_code # => 2xx
|
|
895
895
|
p headers # => { ... }
|
|
@@ -923,7 +923,7 @@ end
|
|
|
923
923
|
|
|
924
924
|
> Object valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post(request_body)
|
|
925
925
|
|
|
926
|
-
|
|
926
|
+
Consult an invoice (Validator)
|
|
927
927
|
|
|
928
928
|
### Examples
|
|
929
929
|
|
|
@@ -940,7 +940,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
940
940
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
941
941
|
|
|
942
942
|
begin
|
|
943
|
-
#
|
|
943
|
+
# Consult an invoice (Validator)
|
|
944
944
|
result = api_instance.valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post(request_body)
|
|
945
945
|
p result
|
|
946
946
|
rescue FactPulse::ApiError => e
|
|
@@ -956,7 +956,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
956
956
|
|
|
957
957
|
```ruby
|
|
958
958
|
begin
|
|
959
|
-
#
|
|
959
|
+
# Consult an invoice (Validator)
|
|
960
960
|
data, status_code, headers = api_instance.valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info(request_body)
|
|
961
961
|
p status_code # => 2xx
|
|
962
962
|
p headers # => { ... }
|
|
@@ -990,9 +990,9 @@ end
|
|
|
990
990
|
|
|
991
991
|
> Object valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post(request_body)
|
|
992
992
|
|
|
993
|
-
|
|
993
|
+
Search invoices to validate (Validator)
|
|
994
994
|
|
|
995
|
-
|
|
995
|
+
Search invoices pending validation by the connected validator. **Role**: Validator in the internal validation workflow. **Filters**: Dates, structure, service, etc.
|
|
996
996
|
|
|
997
997
|
### Examples
|
|
998
998
|
|
|
@@ -1009,7 +1009,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
1009
1009
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1010
1010
|
|
|
1011
1011
|
begin
|
|
1012
|
-
#
|
|
1012
|
+
# Search invoices to validate (Validator)
|
|
1013
1013
|
result = api_instance.valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post(request_body)
|
|
1014
1014
|
p result
|
|
1015
1015
|
rescue FactPulse::ApiError => e
|
|
@@ -1025,7 +1025,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1025
1025
|
|
|
1026
1026
|
```ruby
|
|
1027
1027
|
begin
|
|
1028
|
-
#
|
|
1028
|
+
# Search invoices to validate (Validator)
|
|
1029
1029
|
data, status_code, headers = api_instance.valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info(request_body)
|
|
1030
1030
|
p status_code # => 2xx
|
|
1031
1031
|
p headers # => { ... }
|
|
@@ -1059,9 +1059,9 @@ end
|
|
|
1059
1059
|
|
|
1060
1060
|
> Object valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post(request_body)
|
|
1061
1061
|
|
|
1062
|
-
|
|
1062
|
+
Validate or reject an invoice (Validator)
|
|
1063
1063
|
|
|
1064
|
-
|
|
1064
|
+
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)
|
|
1065
1065
|
|
|
1066
1066
|
### Examples
|
|
1067
1067
|
|
|
@@ -1078,7 +1078,7 @@ api_instance = FactPulse::ChorusProApi.new
|
|
|
1078
1078
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
1079
1079
|
|
|
1080
1080
|
begin
|
|
1081
|
-
#
|
|
1081
|
+
# Validate or reject an invoice (Validator)
|
|
1082
1082
|
result = api_instance.valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post(request_body)
|
|
1083
1083
|
p result
|
|
1084
1084
|
rescue FactPulse::ApiError => e
|
|
@@ -1094,7 +1094,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
1094
1094
|
|
|
1095
1095
|
```ruby
|
|
1096
1096
|
begin
|
|
1097
|
-
#
|
|
1097
|
+
# Validate or reject an invoice (Validator)
|
|
1098
1098
|
data, status_code, headers = api_instance.valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info(request_body)
|
|
1099
1099
|
p status_code # => 2xx
|
|
1100
1100
|
p headers # => { ... }
|