factpulse 1.0.8
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 +7 -0
- data/CHANGELOG.md +28 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +74 -0
- data/LICENSE +21 -0
- data/README.md +161 -0
- data/Rakefile +10 -0
- data/docs/AFNORPDPPAApi.md +69 -0
- data/docs/AFNORPDPPADirectoryServiceApi.md +196 -0
- data/docs/AFNORPDPPAFlowServiceApi.md +258 -0
- data/docs/AdresseElectronique.md +20 -0
- data/docs/AdressePostale.md +26 -0
- data/docs/BodyAjouterFichierApiV1ChorusProTransversesAjouterFichierPost.md +22 -0
- data/docs/BodyCompleterFactureApiV1ChorusProFacturesCompleterPost.md +22 -0
- data/docs/BodyListerServicesStructureApiV1ChorusProStructuresIdStructureCppServicesGet.md +20 -0
- data/docs/BodyRechercherFacturesDestinataireApiV1ChorusProFacturesRechercherDestinatairePost.md +22 -0
- data/docs/BodyRechercherFacturesFournisseurApiV1ChorusProFacturesRechercherFournisseurPost.md +22 -0
- data/docs/BodyRecyclerFactureApiV1ChorusProFacturesRecyclerPost.md +22 -0
- data/docs/BodyTelechargerGroupeFacturesApiV1ChorusProFacturesTelechargerGroupePost.md +22 -0
- data/docs/BodyTraiterFactureRecueApiV1ChorusProFacturesTraiterFactureRecuePost.md +22 -0
- data/docs/BodyValideurConsulterFactureApiV1ChorusProFacturesValideurConsulterPost.md +22 -0
- data/docs/BodyValideurRechercherFacturesApiV1ChorusProFacturesValideurRechercherPost.md +22 -0
- data/docs/BodyValideurTraiterFactureApiV1ChorusProFacturesValideurTraiterPost.md +22 -0
- data/docs/CadreDeFacturation.md +22 -0
- data/docs/CategorieTVA.md +15 -0
- data/docs/CertificateInfoResponse.md +40 -0
- data/docs/ChorusProApi.md +1129 -0
- data/docs/ChorusProCredentials.md +26 -0
- data/docs/CodeCadreFacturation.md +15 -0
- data/docs/CodeRaisonReduction.md +15 -0
- data/docs/ConsulterFactureRequest.md +20 -0
- data/docs/ConsulterFactureResponse.md +34 -0
- data/docs/ConsulterStructureRequest.md +22 -0
- data/docs/ConsulterStructureResponse.md +34 -0
- data/docs/CredentialsAFNOR.md +22 -0
- data/docs/CredentialsChorusPro.md +26 -0
- data/docs/Destinataire.md +24 -0
- data/docs/Destination.md +79 -0
- data/docs/DestinationAFNOR.md +24 -0
- data/docs/DestinationChorusPro.md +20 -0
- data/docs/DirectionFlux.md +15 -0
- data/docs/DonneesFactureSimplifiees.md +34 -0
- data/docs/FactureEnrichieInfoInput.md +32 -0
- data/docs/FactureEnrichieInfoOutput.md +32 -0
- data/docs/FactureFacturX.md +44 -0
- data/docs/FluxResume.md +32 -0
- data/docs/FormatSortie.md +15 -0
- data/docs/Fournisseur.md +34 -0
- data/docs/GenerateCertificateRequest.md +38 -0
- data/docs/GenerateCertificateResponse.md +32 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/InformationSignatureAPI.md +28 -0
- data/docs/LigneDePoste.md +46 -0
- data/docs/LigneDePosteMontantRemiseHt.md +15 -0
- data/docs/LigneDePosteMontantTotalLigneHt.md +15 -0
- data/docs/LigneDePosteTauxTvaManuel.md +15 -0
- data/docs/LigneDeTVA.md +26 -0
- data/docs/ModeDepot.md +15 -0
- data/docs/ModePaiement.md +15 -0
- data/docs/MontantHtTotal.md +15 -0
- data/docs/MontantTotal.md +30 -0
- data/docs/MontantTotalAcompte.md +15 -0
- data/docs/MontantTotalMontantRemiseGlobaleTtc.md +15 -0
- data/docs/MontantTtcTotal.md +15 -0
- data/docs/MontantTva.md +15 -0
- data/docs/Montantapayer.md +15 -0
- data/docs/Montantbaseht.md +15 -0
- data/docs/Montanthttotal.md +15 -0
- data/docs/Montantttctotal.md +15 -0
- data/docs/Montanttva.md +15 -0
- data/docs/Montanttva1.md +15 -0
- data/docs/Montantunitaireht.md +15 -0
- data/docs/ObtenirIdChorusProRequest.md +22 -0
- data/docs/ObtenirIdChorusProResponse.md +24 -0
- data/docs/OptionsProcessing.md +24 -0
- data/docs/PDFFacturXInfo.md +22 -0
- data/docs/PDPCredentials.md +24 -0
- data/docs/ParametresSignature.md +34 -0
- data/docs/ParametresStructure.md +22 -0
- data/docs/PieceJointeComplementaire.md +26 -0
- data/docs/ProcessingEndpointsUnifisApi.md +147 -0
- data/docs/ProfilAPI.md +15 -0
- data/docs/ProfilFlux.md +15 -0
- data/docs/Quantite.md +15 -0
- data/docs/QuotaInfo.md +26 -0
- data/docs/RechercherServicesResponse.md +24 -0
- data/docs/RechercherStructureRequest.md +26 -0
- data/docs/RechercherStructureResponse.md +24 -0
- data/docs/References.md +32 -0
- data/docs/ReponseHealthcheckAFNOR.md +22 -0
- data/docs/ReponseRechercheFlux.md +24 -0
- data/docs/ReponseSoumissionFlux.md +30 -0
- data/docs/ReponseTache.md +18 -0
- data/docs/ReponseValidationErreur.md +18 -0
- data/docs/ReponseValidationSucces.md +18 -0
- data/docs/RequeteRechercheFlux.md +34 -0
- data/docs/RequeteSoumissionFlux.md +28 -0
- data/docs/ResultatAFNOR.md +26 -0
- data/docs/ResultatChorusPro.md +22 -0
- data/docs/ResultatValidationPDFAPI.md +62 -0
- data/docs/SantApi.md +69 -0
- data/docs/SchemeID.md +15 -0
- data/docs/ServiceStructure.md +24 -0
- data/docs/SignatureInfo.md +22 -0
- data/docs/SignatureLectroniqueApi.md +315 -0
- data/docs/SoumettreFactureCompleteRequest.md +26 -0
- data/docs/SoumettreFactureCompleteResponse.md +34 -0
- data/docs/SoumettreFactureRequest.md +46 -0
- data/docs/SoumettreFactureResponse.md +24 -0
- data/docs/StatutAcquittement.md +15 -0
- data/docs/StatutFacture.md +22 -0
- data/docs/StatutTache.md +22 -0
- data/docs/StructureInfo.md +26 -0
- data/docs/SyntaxeFlux.md +15 -0
- data/docs/Tauxmanuel.md +15 -0
- data/docs/TraitementFactureApi.md +831 -0
- data/docs/TypeFacture.md +15 -0
- data/docs/TypeFlux.md +15 -0
- data/docs/TypeTVA.md +15 -0
- data/docs/Unite.md +15 -0
- data/docs/Utilisateur.md +40 -0
- data/docs/UtilisateurApi.md +74 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorLocInner.md +15 -0
- data/factpulse.gemspec +39 -0
- data/git_push.sh +57 -0
- data/lib/factpulse/api/afnorpdppa_api.rb +79 -0
- data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +199 -0
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +256 -0
- data/lib/factpulse/api/chorus_pro_api.rb +1116 -0
- data/lib/factpulse/api/processing_endpoints_unifis_api.rb +158 -0
- data/lib/factpulse/api/sant_api.rb +79 -0
- data/lib/factpulse/api/signature_lectronique_api.rb +333 -0
- data/lib/factpulse/api/traitement_facture_api.rb +835 -0
- data/lib/factpulse/api/utilisateur_api.rb +79 -0
- data/lib/factpulse/api_client.rb +393 -0
- data/lib/factpulse/api_error.rb +58 -0
- data/lib/factpulse/api_model_base.rb +88 -0
- data/lib/factpulse/configuration.rb +308 -0
- data/lib/factpulse/models/adresse_electronique.rb +196 -0
- data/lib/factpulse/models/adresse_postale.rb +189 -0
- data/lib/factpulse/models/body_ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post.rb +202 -0
- data/lib/factpulse/models/body_completer_facture_api_v1_chorus_pro_factures_completer_post.rb +202 -0
- data/lib/factpulse/models/body_lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get.rb +174 -0
- data/lib/factpulse/models/body_rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post.rb +202 -0
- data/lib/factpulse/models/body_rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post.rb +202 -0
- data/lib/factpulse/models/body_recycler_facture_api_v1_chorus_pro_factures_recycler_post.rb +202 -0
- data/lib/factpulse/models/body_telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post.rb +202 -0
- data/lib/factpulse/models/body_traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post.rb +202 -0
- data/lib/factpulse/models/body_valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post.rb +202 -0
- data/lib/factpulse/models/body_valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post.rb +202 -0
- data/lib/factpulse/models/body_valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post.rb +202 -0
- data/lib/factpulse/models/cadre_de_facturation.rb +207 -0
- data/lib/factpulse/models/categorie_tva.rb +47 -0
- data/lib/factpulse/models/certificate_info_response.rb +446 -0
- data/lib/factpulse/models/chorus_pro_credentials.rb +259 -0
- data/lib/factpulse/models/code_cadre_facturation.rb +42 -0
- data/lib/factpulse/models/code_raison_reduction.rb +45 -0
- data/lib/factpulse/models/consulter_facture_request.rb +176 -0
- data/lib/factpulse/models/consulter_facture_response.rb +261 -0
- data/lib/factpulse/models/consulter_structure_request.rb +188 -0
- data/lib/factpulse/models/consulter_structure_response.rb +261 -0
- data/lib/factpulse/models/credentials_afnor.rb +169 -0
- data/lib/factpulse/models/credentials_chorus_pro.rb +191 -0
- data/lib/factpulse/models/destinataire.rb +195 -0
- data/lib/factpulse/models/destination.rb +56 -0
- data/lib/factpulse/models/destination_afnor.rb +228 -0
- data/lib/factpulse/models/destination_chorus_pro.rb +194 -0
- data/lib/factpulse/models/direction_flux.rb +40 -0
- data/lib/factpulse/models/donnees_facture_simplifiees.rb +342 -0
- data/lib/factpulse/models/facture_enrichie_info_input.rb +315 -0
- data/lib/factpulse/models/facture_enrichie_info_output.rb +348 -0
- data/lib/factpulse/models/facture_factur_x.rb +432 -0
- data/lib/factpulse/models/flux_resume.rb +251 -0
- data/lib/factpulse/models/format_sortie.rb +40 -0
- data/lib/factpulse/models/fournisseur.rb +261 -0
- data/lib/factpulse/models/generate_certificate_request.rb +323 -0
- data/lib/factpulse/models/generate_certificate_response.rb +254 -0
- data/lib/factpulse/models/http_validation_error.rb +149 -0
- data/lib/factpulse/models/information_signature_api.rb +216 -0
- data/lib/factpulse/models/ligne_de_poste.rb +391 -0
- data/lib/factpulse/models/ligne_de_poste_montant_remise_ht.rb +104 -0
- data/lib/factpulse/models/ligne_de_poste_montant_total_ligne_ht.rb +104 -0
- data/lib/factpulse/models/ligne_de_poste_taux_tva_manuel.rb +104 -0
- data/lib/factpulse/models/ligne_de_tva.rb +242 -0
- data/lib/factpulse/models/mode_depot.rb +41 -0
- data/lib/factpulse/models/mode_paiement.rb +44 -0
- data/lib/factpulse/models/montant_ht_total.rb +103 -0
- data/lib/factpulse/models/montant_total.rb +273 -0
- data/lib/factpulse/models/montant_total_acompte.rb +104 -0
- data/lib/factpulse/models/montant_total_montant_remise_globale_ttc.rb +104 -0
- data/lib/factpulse/models/montant_ttc_total.rb +103 -0
- data/lib/factpulse/models/montant_tva.rb +103 -0
- data/lib/factpulse/models/montantapayer.rb +104 -0
- data/lib/factpulse/models/montantbaseht.rb +104 -0
- data/lib/factpulse/models/montanthttotal.rb +104 -0
- data/lib/factpulse/models/montantttctotal.rb +104 -0
- data/lib/factpulse/models/montanttva.rb +104 -0
- data/lib/factpulse/models/montanttva1.rb +104 -0
- data/lib/factpulse/models/montantunitaireht.rb +104 -0
- data/lib/factpulse/models/obtenir_id_chorus_pro_request.rb +188 -0
- data/lib/factpulse/models/obtenir_id_chorus_pro_response.rb +230 -0
- data/lib/factpulse/models/options_processing.rb +221 -0
- data/lib/factpulse/models/parametres_signature.rb +235 -0
- data/lib/factpulse/models/parametres_structure.rb +175 -0
- data/lib/factpulse/models/pdf_factur_x_info.rb +205 -0
- data/lib/factpulse/models/pdp_credentials.rb +247 -0
- data/lib/factpulse/models/piece_jointe_complementaire.rb +269 -0
- data/lib/factpulse/models/profil_api.rb +42 -0
- data/lib/factpulse/models/profil_flux.rb +41 -0
- data/lib/factpulse/models/quantite.rb +104 -0
- data/lib/factpulse/models/quota_info.rb +269 -0
- data/lib/factpulse/models/rechercher_services_response.rb +214 -0
- data/lib/factpulse/models/rechercher_structure_request.rb +191 -0
- data/lib/factpulse/models/rechercher_structure_response.rb +216 -0
- data/lib/factpulse/models/references.rb +290 -0
- data/lib/factpulse/models/reponse_healthcheck_afnor.rb +220 -0
- data/lib/factpulse/models/reponse_recherche_flux.rb +249 -0
- data/lib/factpulse/models/reponse_soumission_flux.rb +294 -0
- data/lib/factpulse/models/reponse_tache.rb +165 -0
- data/lib/factpulse/models/reponse_validation_erreur.rb +167 -0
- data/lib/factpulse/models/reponse_validation_succes.rb +165 -0
- data/lib/factpulse/models/requete_recherche_flux.rb +306 -0
- data/lib/factpulse/models/requete_soumission_flux.rb +238 -0
- data/lib/factpulse/models/resultat_afnor.rb +240 -0
- data/lib/factpulse/models/resultat_chorus_pro.rb +186 -0
- data/lib/factpulse/models/resultat_validation_pdfapi.rb +523 -0
- data/lib/factpulse/models/scheme_id.rb +43 -0
- data/lib/factpulse/models/service_structure.rb +247 -0
- data/lib/factpulse/models/signature_info.rb +186 -0
- data/lib/factpulse/models/soumettre_facture_complete_request.rb +239 -0
- data/lib/factpulse/models/soumettre_facture_complete_response.rb +355 -0
- data/lib/factpulse/models/soumettre_facture_request.rb +391 -0
- data/lib/factpulse/models/soumettre_facture_response.rb +213 -0
- data/lib/factpulse/models/statut_acquittement.rb +41 -0
- data/lib/factpulse/models/statut_facture.rb +203 -0
- data/lib/factpulse/models/statut_tache.rb +201 -0
- data/lib/factpulse/models/structure_info.rb +274 -0
- data/lib/factpulse/models/syntaxe_flux.rb +43 -0
- data/lib/factpulse/models/tauxmanuel.rb +104 -0
- data/lib/factpulse/models/type_facture.rb +40 -0
- data/lib/factpulse/models/type_flux.rb +43 -0
- data/lib/factpulse/models/type_tva.rb +42 -0
- data/lib/factpulse/models/unite.rb +44 -0
- data/lib/factpulse/models/utilisateur.rb +328 -0
- data/lib/factpulse/models/validation_error.rb +218 -0
- data/lib/factpulse/models/validation_error_loc_inner.rb +103 -0
- data/lib/factpulse/version.rb +15 -0
- data/lib/factpulse.rb +157 -0
- metadata +382 -0
data/docs/SantApi.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# FactPulse::SantApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**racine_get**](SantApi.md#racine_get) | **GET** / | Vérifier l'état de l'API |
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## racine_get
|
|
11
|
+
|
|
12
|
+
> Object racine_get
|
|
13
|
+
|
|
14
|
+
Vérifier l'état de l'API
|
|
15
|
+
|
|
16
|
+
Endpoint de health check pour vérifier que l'API répond. Utile pour : - Monitoring de disponibilité - Tests d'intégration - Load balancers
|
|
17
|
+
|
|
18
|
+
### Examples
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'time'
|
|
22
|
+
require 'factpulse'
|
|
23
|
+
|
|
24
|
+
api_instance = FactPulse::SantApi.new
|
|
25
|
+
|
|
26
|
+
begin
|
|
27
|
+
# Vérifier l'état de l'API
|
|
28
|
+
result = api_instance.racine_get
|
|
29
|
+
p result
|
|
30
|
+
rescue FactPulse::ApiError => e
|
|
31
|
+
puts "Error when calling SantApi->racine_get: #{e}"
|
|
32
|
+
end
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
#### Using the racine_get_with_http_info variant
|
|
36
|
+
|
|
37
|
+
This returns an Array which contains the response data, status code and headers.
|
|
38
|
+
|
|
39
|
+
> <Array(Object, Integer, Hash)> racine_get_with_http_info
|
|
40
|
+
|
|
41
|
+
```ruby
|
|
42
|
+
begin
|
|
43
|
+
# Vérifier l'état de l'API
|
|
44
|
+
data, status_code, headers = api_instance.racine_get_with_http_info
|
|
45
|
+
p status_code # => 2xx
|
|
46
|
+
p headers # => { ... }
|
|
47
|
+
p data # => Object
|
|
48
|
+
rescue FactPulse::ApiError => e
|
|
49
|
+
puts "Error when calling SantApi->racine_get_with_http_info: #{e}"
|
|
50
|
+
end
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
This endpoint does not need any parameter.
|
|
56
|
+
|
|
57
|
+
### Return type
|
|
58
|
+
|
|
59
|
+
**Object**
|
|
60
|
+
|
|
61
|
+
### Authorization
|
|
62
|
+
|
|
63
|
+
No authorization required
|
|
64
|
+
|
|
65
|
+
### HTTP request headers
|
|
66
|
+
|
|
67
|
+
- **Content-Type**: Not defined
|
|
68
|
+
- **Accept**: application/json
|
|
69
|
+
|
data/docs/SchemeID.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FactPulse::ServiceStructure
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_service** | **Integer** | ID du service | |
|
|
8
|
+
| **code_service** | **String** | Code du service | |
|
|
9
|
+
| **libelle_service** | **String** | Libellé du service | |
|
|
10
|
+
| **est_actif** | **Boolean** | Service actif | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'factpulse'
|
|
16
|
+
|
|
17
|
+
instance = FactPulse::ServiceStructure.new(
|
|
18
|
+
id_service: null,
|
|
19
|
+
code_service: null,
|
|
20
|
+
libelle_service: null,
|
|
21
|
+
est_actif: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::SignatureInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **signe** | **Boolean** | Le PDF a été signé | |
|
|
8
|
+
| **cn** | **String** | | [optional] |
|
|
9
|
+
| **expiration** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::SignatureInfo.new(
|
|
17
|
+
signe: null,
|
|
18
|
+
cn: null,
|
|
19
|
+
expiration: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
# FactPulse::SignatureLectroniqueApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**generer_certificat_test_api_v1_traitement_generer_certificat_test_post**](SignatureLectroniqueApi.md#generer_certificat_test_api_v1_traitement_generer_certificat_test_post) | **POST** /api/v1/traitement/generer-certificat-test | Générer un certificat X.509 auto-signé de test |
|
|
8
|
+
| [**signer_pdf_api_v1_traitement_signer_pdf_post**](SignatureLectroniqueApi.md#signer_pdf_api_v1_traitement_signer_pdf_post) | **POST** /api/v1/traitement/signer-pdf | Signer un PDF avec le certificat du client (PAdES-B-LT) |
|
|
9
|
+
| [**signer_pdf_async_api_v1_traitement_signer_pdf_async_post**](SignatureLectroniqueApi.md#signer_pdf_async_api_v1_traitement_signer_pdf_async_post) | **POST** /api/v1/traitement/signer-pdf-async | Signer un PDF de manière asynchrone (Celery) |
|
|
10
|
+
| [**valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post**](SignatureLectroniqueApi.md#valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post) | **POST** /api/v1/traitement/valider-signature-pdf | Valider les signatures électroniques d'un PDF |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## generer_certificat_test_api_v1_traitement_generer_certificat_test_post
|
|
14
|
+
|
|
15
|
+
> <GenerateCertificateResponse> generer_certificat_test_api_v1_traitement_generer_certificat_test_post(generate_certificate_request)
|
|
16
|
+
|
|
17
|
+
Générer un certificat X.509 auto-signé de test
|
|
18
|
+
|
|
19
|
+
Génère un certificat X.509 auto-signé pour les tests de signature électronique PDF. **⚠️ ATTENTION : Certificat de TEST uniquement !** Ce certificat est : - ✅ Adapté pour tests et développement - ✅ Compatible signature PDF (PAdES) - ✅ Conforme eIDAS niveau **SES** (Simple Electronic Signature) - ❌ **JAMAIS utilisable en production** - ❌ **Non reconnu** par les navigateurs et lecteurs PDF - ❌ **Aucune valeur juridique** ## Niveaux eIDAS - **SES** (Simple) : Certificat auto-signé ← Généré par cet endpoint - **AdES** (Advanced) : Certificat CA commerciale (Let's Encrypt, etc.) - **QES** (Qualified) : Certificat qualifié PSCO (CertEurope, Universign, etc.) ## Utilisation Une fois généré, le certificat peut être : 1. **Enregistré dans Django** (recommandé) : - Django Admin > Certificats de signature - Upload `certificat_pem` et `cle_privee_pem` 2. **Utilisé directement** : - Signer un PDF avec `/signer-pdf` - Le certificat sera automatiquement utilisé ## Exemple d'appel ```bash curl -X POST \"https://www.factpulse.fr/api/facturation/generer-certificat-test\" \\ -H \"Authorization: Bearer eyJ0eXAi...\" \\ -H \"Content-Type: application/json\" \\ -d '{ \"cn\": \"Test Client XYZ\", \"organisation\": \"Client XYZ SARL\", \"email\": \"contact@xyz.fr\", \"duree_jours\": 365 }' ``` ## Cas d'usage - Tests de signature PDF en développement - POC de signature électronique - Formation et démos - Tests d'intégration automatisés ## Conformité technique Certificat généré avec : - Clé RSA 2048 ou 4096 bits - Algorithme SHA-256 - Extensions Key Usage : `digitalSignature`, `contentCommitment` (non-repudiation) - Extensions Extended Key Usage : `codeSigning`, `emailProtection` - Validité : 1 jour à 10 ans (configurable) - Format : PEM (certificat et clé) - Optionnel : PKCS#12 (.p12)
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'factpulse'
|
|
26
|
+
# setup authorization
|
|
27
|
+
FactPulse.configure do |config|
|
|
28
|
+
# Configure Bearer authorization: HTTPBearer
|
|
29
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = FactPulse::SignatureLectroniqueApi.new
|
|
33
|
+
generate_certificate_request = FactPulse::GenerateCertificateRequest.new # GenerateCertificateRequest |
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
# Générer un certificat X.509 auto-signé de test
|
|
37
|
+
result = api_instance.generer_certificat_test_api_v1_traitement_generer_certificat_test_post(generate_certificate_request)
|
|
38
|
+
p result
|
|
39
|
+
rescue FactPulse::ApiError => e
|
|
40
|
+
puts "Error when calling SignatureLectroniqueApi->generer_certificat_test_api_v1_traitement_generer_certificat_test_post: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Using the generer_certificat_test_api_v1_traitement_generer_certificat_test_post_with_http_info variant
|
|
45
|
+
|
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
|
47
|
+
|
|
48
|
+
> <Array(<GenerateCertificateResponse>, Integer, Hash)> generer_certificat_test_api_v1_traitement_generer_certificat_test_post_with_http_info(generate_certificate_request)
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
begin
|
|
52
|
+
# Générer un certificat X.509 auto-signé de test
|
|
53
|
+
data, status_code, headers = api_instance.generer_certificat_test_api_v1_traitement_generer_certificat_test_post_with_http_info(generate_certificate_request)
|
|
54
|
+
p status_code # => 2xx
|
|
55
|
+
p headers # => { ... }
|
|
56
|
+
p data # => <GenerateCertificateResponse>
|
|
57
|
+
rescue FactPulse::ApiError => e
|
|
58
|
+
puts "Error when calling SignatureLectroniqueApi->generer_certificat_test_api_v1_traitement_generer_certificat_test_post_with_http_info: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
| Name | Type | Description | Notes |
|
|
65
|
+
| ---- | ---- | ----------- | ----- |
|
|
66
|
+
| **generate_certificate_request** | [**GenerateCertificateRequest**](GenerateCertificateRequest.md) | | |
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
[**GenerateCertificateResponse**](GenerateCertificateResponse.md)
|
|
71
|
+
|
|
72
|
+
### Authorization
|
|
73
|
+
|
|
74
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
75
|
+
|
|
76
|
+
### HTTP request headers
|
|
77
|
+
|
|
78
|
+
- **Content-Type**: application/json
|
|
79
|
+
- **Accept**: application/json
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
## signer_pdf_api_v1_traitement_signer_pdf_post
|
|
83
|
+
|
|
84
|
+
> Object signer_pdf_api_v1_traitement_signer_pdf_post(fichier_pdf, opts)
|
|
85
|
+
|
|
86
|
+
Signer un PDF avec le certificat du client (PAdES-B-LT)
|
|
87
|
+
|
|
88
|
+
Signe un PDF uploadé avec le certificat électronique configuré pour le client (via client_uid du JWT). **Standards supportés** : PAdES-B-B, PAdES-B-T (horodatage), PAdES-B-LT (archivage long terme). **Niveaux eIDAS** : SES (auto-signé), AdES (CA commerciale), QES (PSCO - hors scope). **⚠️ Disclaimer légal** : Les signatures générées sont des cachets électroniques au sens du règlement eIDAS. Le niveau de validité juridique dépend du certificat utilisé (SES/AdES/QES). FactPulse ne fournit pas de certificats qualifiés QES - vous devez obtenir un certificat auprès d'un PSCO (Prestataire de Services de Confiance qualifié) pour une validité juridique maximale.
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
require 'time'
|
|
94
|
+
require 'factpulse'
|
|
95
|
+
# setup authorization
|
|
96
|
+
FactPulse.configure do |config|
|
|
97
|
+
# Configure Bearer authorization: HTTPBearer
|
|
98
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
api_instance = FactPulse::SignatureLectroniqueApi.new
|
|
102
|
+
fichier_pdf = File.new('/path/to/some/file') # File | Fichier PDF à signer (sera traité puis retourné signé en base64)
|
|
103
|
+
opts = {
|
|
104
|
+
raison: 'raison_example', # String |
|
|
105
|
+
localisation: 'localisation_example', # String |
|
|
106
|
+
contact: 'contact_example', # String |
|
|
107
|
+
field_name: 'field_name_example', # String | Nom du champ de signature PDF
|
|
108
|
+
use_pades_lt: true, # Boolean | Activer PAdES-B-LT (archivage long terme avec données de validation embarquées). NÉCESSITE un certificat avec accès OCSP/CRL.
|
|
109
|
+
use_timestamp: true # Boolean | Activer l'horodatage RFC 3161 avec FreeTSA (PAdES-B-T)
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
begin
|
|
113
|
+
# Signer un PDF avec le certificat du client (PAdES-B-LT)
|
|
114
|
+
result = api_instance.signer_pdf_api_v1_traitement_signer_pdf_post(fichier_pdf, opts)
|
|
115
|
+
p result
|
|
116
|
+
rescue FactPulse::ApiError => e
|
|
117
|
+
puts "Error when calling SignatureLectroniqueApi->signer_pdf_api_v1_traitement_signer_pdf_post: #{e}"
|
|
118
|
+
end
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
#### Using the signer_pdf_api_v1_traitement_signer_pdf_post_with_http_info variant
|
|
122
|
+
|
|
123
|
+
This returns an Array which contains the response data, status code and headers.
|
|
124
|
+
|
|
125
|
+
> <Array(Object, Integer, Hash)> signer_pdf_api_v1_traitement_signer_pdf_post_with_http_info(fichier_pdf, opts)
|
|
126
|
+
|
|
127
|
+
```ruby
|
|
128
|
+
begin
|
|
129
|
+
# Signer un PDF avec le certificat du client (PAdES-B-LT)
|
|
130
|
+
data, status_code, headers = api_instance.signer_pdf_api_v1_traitement_signer_pdf_post_with_http_info(fichier_pdf, opts)
|
|
131
|
+
p status_code # => 2xx
|
|
132
|
+
p headers # => { ... }
|
|
133
|
+
p data # => Object
|
|
134
|
+
rescue FactPulse::ApiError => e
|
|
135
|
+
puts "Error when calling SignatureLectroniqueApi->signer_pdf_api_v1_traitement_signer_pdf_post_with_http_info: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
| Name | Type | Description | Notes |
|
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
|
143
|
+
| **fichier_pdf** | **File** | Fichier PDF à signer (sera traité puis retourné signé en base64) | |
|
|
144
|
+
| **raison** | **String** | | [optional] |
|
|
145
|
+
| **localisation** | **String** | | [optional] |
|
|
146
|
+
| **contact** | **String** | | [optional] |
|
|
147
|
+
| **field_name** | **String** | Nom du champ de signature PDF | [optional][default to 'FactPulseSignature'] |
|
|
148
|
+
| **use_pades_lt** | **Boolean** | Activer PAdES-B-LT (archivage long terme avec données de validation embarquées). NÉCESSITE un certificat avec accès OCSP/CRL. | [optional][default to false] |
|
|
149
|
+
| **use_timestamp** | **Boolean** | Activer l'horodatage RFC 3161 avec FreeTSA (PAdES-B-T) | [optional][default to true] |
|
|
150
|
+
|
|
151
|
+
### Return type
|
|
152
|
+
|
|
153
|
+
**Object**
|
|
154
|
+
|
|
155
|
+
### Authorization
|
|
156
|
+
|
|
157
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
158
|
+
|
|
159
|
+
### HTTP request headers
|
|
160
|
+
|
|
161
|
+
- **Content-Type**: multipart/form-data
|
|
162
|
+
- **Accept**: application/json
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
## signer_pdf_async_api_v1_traitement_signer_pdf_async_post
|
|
166
|
+
|
|
167
|
+
> Object signer_pdf_async_api_v1_traitement_signer_pdf_async_post(fichier_pdf, opts)
|
|
168
|
+
|
|
169
|
+
Signer un PDF de manière asynchrone (Celery)
|
|
170
|
+
|
|
171
|
+
Signe un PDF uploadé de manière asynchrone via une tâche Celery. **Différence avec /signer-pdf** : - `/signer-pdf` : Signature synchrone (blocage jusqu'à la fin) - `/signer-pdf-async` : Signature asynchrone (retourne immédiatement un task_id) **Avantages de l'async** : - Pas de timeout pour les gros fichiers - Pas de blocage du worker FastAPI - Possibilité de suivre la progression via le task_id - Idéal pour les traitements par lot **Standards supportés** : PAdES-B-B, PAdES-B-T (horodatage), PAdES-B-LT (archivage long terme). **⚠️ Disclaimer légal** : Identique à /signer-pdf (voir documentation de cet endpoint).
|
|
172
|
+
|
|
173
|
+
### Examples
|
|
174
|
+
|
|
175
|
+
```ruby
|
|
176
|
+
require 'time'
|
|
177
|
+
require 'factpulse'
|
|
178
|
+
# setup authorization
|
|
179
|
+
FactPulse.configure do |config|
|
|
180
|
+
# Configure Bearer authorization: HTTPBearer
|
|
181
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
api_instance = FactPulse::SignatureLectroniqueApi.new
|
|
185
|
+
fichier_pdf = File.new('/path/to/some/file') # File | Fichier PDF à signer (traité de manière asynchrone)
|
|
186
|
+
opts = {
|
|
187
|
+
raison: 'raison_example', # String |
|
|
188
|
+
localisation: 'localisation_example', # String |
|
|
189
|
+
contact: 'contact_example', # String |
|
|
190
|
+
field_name: 'field_name_example', # String | Nom du champ de signature PDF
|
|
191
|
+
use_pades_lt: true, # Boolean | Activer PAdES-B-LT (archivage long terme avec données de validation embarquées). NÉCESSITE un certificat avec accès OCSP/CRL.
|
|
192
|
+
use_timestamp: true # Boolean | Activer l'horodatage RFC 3161 avec FreeTSA (PAdES-B-T)
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
begin
|
|
196
|
+
# Signer un PDF de manière asynchrone (Celery)
|
|
197
|
+
result = api_instance.signer_pdf_async_api_v1_traitement_signer_pdf_async_post(fichier_pdf, opts)
|
|
198
|
+
p result
|
|
199
|
+
rescue FactPulse::ApiError => e
|
|
200
|
+
puts "Error when calling SignatureLectroniqueApi->signer_pdf_async_api_v1_traitement_signer_pdf_async_post: #{e}"
|
|
201
|
+
end
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
#### Using the signer_pdf_async_api_v1_traitement_signer_pdf_async_post_with_http_info variant
|
|
205
|
+
|
|
206
|
+
This returns an Array which contains the response data, status code and headers.
|
|
207
|
+
|
|
208
|
+
> <Array(Object, Integer, Hash)> signer_pdf_async_api_v1_traitement_signer_pdf_async_post_with_http_info(fichier_pdf, opts)
|
|
209
|
+
|
|
210
|
+
```ruby
|
|
211
|
+
begin
|
|
212
|
+
# Signer un PDF de manière asynchrone (Celery)
|
|
213
|
+
data, status_code, headers = api_instance.signer_pdf_async_api_v1_traitement_signer_pdf_async_post_with_http_info(fichier_pdf, opts)
|
|
214
|
+
p status_code # => 2xx
|
|
215
|
+
p headers # => { ... }
|
|
216
|
+
p data # => Object
|
|
217
|
+
rescue FactPulse::ApiError => e
|
|
218
|
+
puts "Error when calling SignatureLectroniqueApi->signer_pdf_async_api_v1_traitement_signer_pdf_async_post_with_http_info: #{e}"
|
|
219
|
+
end
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
| Name | Type | Description | Notes |
|
|
225
|
+
| ---- | ---- | ----------- | ----- |
|
|
226
|
+
| **fichier_pdf** | **File** | Fichier PDF à signer (traité de manière asynchrone) | |
|
|
227
|
+
| **raison** | **String** | | [optional] |
|
|
228
|
+
| **localisation** | **String** | | [optional] |
|
|
229
|
+
| **contact** | **String** | | [optional] |
|
|
230
|
+
| **field_name** | **String** | Nom du champ de signature PDF | [optional][default to 'FactPulseSignature'] |
|
|
231
|
+
| **use_pades_lt** | **Boolean** | Activer PAdES-B-LT (archivage long terme avec données de validation embarquées). NÉCESSITE un certificat avec accès OCSP/CRL. | [optional][default to false] |
|
|
232
|
+
| **use_timestamp** | **Boolean** | Activer l'horodatage RFC 3161 avec FreeTSA (PAdES-B-T) | [optional][default to true] |
|
|
233
|
+
|
|
234
|
+
### Return type
|
|
235
|
+
|
|
236
|
+
**Object**
|
|
237
|
+
|
|
238
|
+
### Authorization
|
|
239
|
+
|
|
240
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
241
|
+
|
|
242
|
+
### HTTP request headers
|
|
243
|
+
|
|
244
|
+
- **Content-Type**: multipart/form-data
|
|
245
|
+
- **Accept**: application/json
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
## valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post
|
|
249
|
+
|
|
250
|
+
> Object valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post(fichier_pdf)
|
|
251
|
+
|
|
252
|
+
Valider les signatures électroniques d'un PDF
|
|
253
|
+
|
|
254
|
+
Valide les signatures électroniques présentes dans un PDF uploadé. **Vérifications effectuées** : - Présence de signatures - Intégrité du document (non modifié depuis signature) - Validité des certificats - Chaîne de confiance (si disponible) - Présence d'horodatage (PAdES-B-T) - Données de validation (PAdES-B-LT) **Standards supportés** : PAdES-B-B, PAdES-B-T, PAdES-B-LT, ISO 32000-2. **⚠️ Note** : Cette validation est technique (intégrité cryptographique). La validité juridique dépend du niveau eIDAS du certificat (SES/AdES/QES) et du contexte d'utilisation.
|
|
255
|
+
|
|
256
|
+
### Examples
|
|
257
|
+
|
|
258
|
+
```ruby
|
|
259
|
+
require 'time'
|
|
260
|
+
require 'factpulse'
|
|
261
|
+
# setup authorization
|
|
262
|
+
FactPulse.configure do |config|
|
|
263
|
+
# Configure Bearer authorization: HTTPBearer
|
|
264
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
api_instance = FactPulse::SignatureLectroniqueApi.new
|
|
268
|
+
fichier_pdf = File.new('/path/to/some/file') # File | Fichier PDF à valider (sera analysé pour détecter et valider les signatures)
|
|
269
|
+
|
|
270
|
+
begin
|
|
271
|
+
# Valider les signatures électroniques d'un PDF
|
|
272
|
+
result = api_instance.valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post(fichier_pdf)
|
|
273
|
+
p result
|
|
274
|
+
rescue FactPulse::ApiError => e
|
|
275
|
+
puts "Error when calling SignatureLectroniqueApi->valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post: #{e}"
|
|
276
|
+
end
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
#### Using the valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post_with_http_info variant
|
|
280
|
+
|
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
|
282
|
+
|
|
283
|
+
> <Array(Object, Integer, Hash)> valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post_with_http_info(fichier_pdf)
|
|
284
|
+
|
|
285
|
+
```ruby
|
|
286
|
+
begin
|
|
287
|
+
# Valider les signatures électroniques d'un PDF
|
|
288
|
+
data, status_code, headers = api_instance.valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post_with_http_info(fichier_pdf)
|
|
289
|
+
p status_code # => 2xx
|
|
290
|
+
p headers # => { ... }
|
|
291
|
+
p data # => Object
|
|
292
|
+
rescue FactPulse::ApiError => e
|
|
293
|
+
puts "Error when calling SignatureLectroniqueApi->valider_signature_pdf_endpoint_api_v1_traitement_valider_signature_pdf_post_with_http_info: #{e}"
|
|
294
|
+
end
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
| Name | Type | Description | Notes |
|
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
|
301
|
+
| **fichier_pdf** | **File** | Fichier PDF à valider (sera analysé pour détecter et valider les signatures) | |
|
|
302
|
+
|
|
303
|
+
### Return type
|
|
304
|
+
|
|
305
|
+
**Object**
|
|
306
|
+
|
|
307
|
+
### Authorization
|
|
308
|
+
|
|
309
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
310
|
+
|
|
311
|
+
### HTTP request headers
|
|
312
|
+
|
|
313
|
+
- **Content-Type**: multipart/form-data
|
|
314
|
+
- **Accept**: application/json
|
|
315
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# FactPulse::SoumettreFactureCompleteRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **donnees_facture** | [**DonneesFactureSimplifiees**](DonneesFactureSimplifiees.md) | Données de la facture au format simplifié (voir exemples) | |
|
|
8
|
+
| **pdf_source** | **String** | PDF source encodé en base64 (sera transformé en Factur-X) | |
|
|
9
|
+
| **destination** | [**Destination**](Destination.md) | | |
|
|
10
|
+
| **signature** | [**ParametresSignature**](ParametresSignature.md) | | [optional] |
|
|
11
|
+
| **options** | [**OptionsProcessing**](OptionsProcessing.md) | Options de traitement | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'factpulse'
|
|
17
|
+
|
|
18
|
+
instance = FactPulse::SoumettreFactureCompleteRequest.new(
|
|
19
|
+
donnees_facture: null,
|
|
20
|
+
pdf_source: null,
|
|
21
|
+
destination: null,
|
|
22
|
+
signature: null,
|
|
23
|
+
options: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# FactPulse::SoumettreFactureCompleteResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **succes** | **Boolean** | La facture a été soumise avec succès | |
|
|
8
|
+
| **destination_type** | **String** | Type de destination | |
|
|
9
|
+
| **resultat_chorus** | [**ResultatChorusPro**](ResultatChorusPro.md) | | [optional] |
|
|
10
|
+
| **resultat_afnor** | [**ResultatAFNOR**](ResultatAFNOR.md) | | [optional] |
|
|
11
|
+
| **facture_enrichie** | [**FactureEnrichieInfoOutput**](FactureEnrichieInfoOutput.md) | Données de la facture enrichie | |
|
|
12
|
+
| **pdf_facturx** | [**PDFFacturXInfo**](PDFFacturXInfo.md) | Informations sur le PDF généré | |
|
|
13
|
+
| **signature** | [**SignatureInfo**](SignatureInfo.md) | | [optional] |
|
|
14
|
+
| **pdf_base64** | **String** | PDF Factur-X généré (et signé si demandé) encodé en base64 | |
|
|
15
|
+
| **message** | **String** | Message de retour | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'factpulse'
|
|
21
|
+
|
|
22
|
+
instance = FactPulse::SoumettreFactureCompleteResponse.new(
|
|
23
|
+
succes: null,
|
|
24
|
+
destination_type: null,
|
|
25
|
+
resultat_chorus: null,
|
|
26
|
+
resultat_afnor: null,
|
|
27
|
+
facture_enrichie: null,
|
|
28
|
+
pdf_facturx: null,
|
|
29
|
+
signature: null,
|
|
30
|
+
pdf_base64: null,
|
|
31
|
+
message: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# FactPulse::SoumettreFactureRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) | | [optional] |
|
|
8
|
+
| **numero_facture** | **String** | Numéro de la facture | |
|
|
9
|
+
| **date_facture** | **String** | Date de facture (format ISO: YYYY-MM-DD) | |
|
|
10
|
+
| **date_echeance_paiement** | **String** | | [optional] |
|
|
11
|
+
| **id_structure_cpp** | **Integer** | ID Chorus Pro de la structure destinataire | |
|
|
12
|
+
| **code_service** | **String** | | [optional] |
|
|
13
|
+
| **numero_engagement** | **String** | | [optional] |
|
|
14
|
+
| **montant_ht_total** | **String** | Montant HT total | |
|
|
15
|
+
| **montant_tva** | **String** | Montant TVA | |
|
|
16
|
+
| **montant_ttc_total** | **String** | Montant TTC total | |
|
|
17
|
+
| **piece_jointe_principale_id** | **Integer** | | [optional] |
|
|
18
|
+
| **piece_jointe_principale_designation** | **String** | | [optional] |
|
|
19
|
+
| **commentaire** | **String** | | [optional] |
|
|
20
|
+
| **numero_bon_commande** | **String** | | [optional] |
|
|
21
|
+
| **numero_marche** | **String** | | [optional] |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'factpulse'
|
|
27
|
+
|
|
28
|
+
instance = FactPulse::SoumettreFactureRequest.new(
|
|
29
|
+
credentials: null,
|
|
30
|
+
numero_facture: null,
|
|
31
|
+
date_facture: null,
|
|
32
|
+
date_echeance_paiement: null,
|
|
33
|
+
id_structure_cpp: null,
|
|
34
|
+
code_service: null,
|
|
35
|
+
numero_engagement: null,
|
|
36
|
+
montant_ht_total: null,
|
|
37
|
+
montant_tva: null,
|
|
38
|
+
montant_ttc_total: null,
|
|
39
|
+
piece_jointe_principale_id: null,
|
|
40
|
+
piece_jointe_principale_designation: null,
|
|
41
|
+
commentaire: null,
|
|
42
|
+
numero_bon_commande: null,
|
|
43
|
+
numero_marche: null
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FactPulse::SoumettreFactureResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code_retour** | **Integer** | Code retour (0 = succès) | |
|
|
8
|
+
| **libelle** | **String** | Message de retour | |
|
|
9
|
+
| **identifiant_facture_cpp** | **Integer** | | [optional] |
|
|
10
|
+
| **numero_flux_depot** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'factpulse'
|
|
16
|
+
|
|
17
|
+
instance = FactPulse::SoumettreFactureResponse.new(
|
|
18
|
+
code_retour: null,
|
|
19
|
+
libelle: null,
|
|
20
|
+
identifiant_facture_cpp: null,
|
|
21
|
+
numero_flux_depot: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::StatutFacture
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Code statut (SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc.) | |
|
|
8
|
+
| **libelle** | **String** | Libellé du statut | |
|
|
9
|
+
| **date** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::StatutFacture.new(
|
|
17
|
+
code: null,
|
|
18
|
+
libelle: null,
|
|
19
|
+
date: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/StatutTache.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::StatutTache
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_tache** | **String** | | |
|
|
8
|
+
| **statut** | **String** | | |
|
|
9
|
+
| **resultat** | [**AnyOf**](AnyOf.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::StatutTache.new(
|
|
17
|
+
id_tache: null,
|
|
18
|
+
statut: null,
|
|
19
|
+
resultat: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# FactPulse::StructureInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_structure_cpp** | **Integer** | ID Chorus Pro de la structure | |
|
|
8
|
+
| **identifiant_structure** | **String** | Identifiant (SIRET, SIREN) | |
|
|
9
|
+
| **designation_structure** | **String** | Nom de la structure | |
|
|
10
|
+
| **type_identifiant_structure** | **String** | Type d'identifiant | |
|
|
11
|
+
| **statut** | **String** | Statut (ACTIVE, INACTIVE) | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'factpulse'
|
|
17
|
+
|
|
18
|
+
instance = FactPulse::StructureInfo.new(
|
|
19
|
+
id_structure_cpp: null,
|
|
20
|
+
identifiant_structure: null,
|
|
21
|
+
designation_structure: null,
|
|
22
|
+
type_identifiant_structure: null,
|
|
23
|
+
statut: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|