factpulse 1.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 +7 -0
- data/CHANGELOG.md +28 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +74 -0
- data/LICENSE +21 -0
- data/README.md +207 -0
- data/Rakefile +10 -0
- data/docs/AFNORPDPPAApi.md +69 -0
- data/docs/AFNORPDPPADirectoryServiceApi.md +1313 -0
- data/docs/AFNORPDPPAFlowServiceApi.md +258 -0
- data/docs/APIError.md +22 -0
- data/docs/AdresseElectronique.md +20 -0
- data/docs/AdressePostale.md +26 -0
- data/docs/CadreDeFacturation.md +22 -0
- data/docs/CategorieTVA.md +15 -0
- data/docs/CertificateInfoResponse.md +40 -0
- data/docs/ChorusProApi.md +1125 -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 +28 -0
- data/docs/Destination.md +79 -0
- data/docs/DestinationAFNOR.md +24 -0
- data/docs/DestinationChorusPro.md +20 -0
- data/docs/DonneesFactureSimplifiees.md +34 -0
- data/docs/ErrorLevel.md +15 -0
- data/docs/ErrorSource.md +15 -0
- data/docs/FactureEnrichieInfo.md +32 -0
- data/docs/FactureFacturX.md +46 -0
- data/docs/FormatSortie.md +15 -0
- data/docs/Fournisseur.md +36 -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/LigneDePosteTauxTvaManuel.md +15 -0
- data/docs/LigneDeTVA.md +26 -0
- data/docs/ModeDepot.md +15 -0
- data/docs/ModePaiement.md +15 -0
- data/docs/MontantAPayer.md +15 -0
- data/docs/MontantBaseHt.md +15 -0
- data/docs/MontantHtTotal.md +15 -0
- data/docs/MontantRemiseGlobaleTtc.md +15 -0
- data/docs/MontantTotal.md +30 -0
- data/docs/MontantTotalAcompte.md +15 -0
- data/docs/MontantTotalLigneHt.md +15 -0
- data/docs/MontantTtcTotal.md +15 -0
- data/docs/MontantTva.md +15 -0
- data/docs/MontantTvaLigne.md +15 -0
- data/docs/MontantTvaTotal.md +15 -0
- data/docs/MontantUnitaireHt.md +15 -0
- data/docs/Note.md +20 -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/ParametresSignature.md +34 -0
- data/docs/ParametresStructure.md +22 -0
- data/docs/PieceJointeComplementaire.md +26 -0
- data/docs/ProfilAPI.md +15 -0
- data/docs/Quantite.md +15 -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/ReponseTache.md +18 -0
- data/docs/ReponseValidationErreur.md +18 -0
- data/docs/ReponseValidationSucces.md +18 -0
- data/docs/ResultatAFNOR.md +26 -0
- data/docs/ResultatChorusPro.md +22 -0
- data/docs/ResultatValidationPDFAPI.md +62 -0
- data/docs/SantApi.md +131 -0
- data/docs/SchemeID.md +15 -0
- data/docs/ServiceStructure.md +24 -0
- data/docs/SignatureInfo.md +22 -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/StatutCelery.md +15 -0
- data/docs/StatutFacture.md +22 -0
- data/docs/StatutTache.md +22 -0
- data/docs/StructureInfo.md +26 -0
- data/docs/Tauxmanuel.md +15 -0
- data/docs/TraitementFactureApi.md +831 -0
- data/docs/TypeFacture.md +15 -0
- data/docs/TypeTVA.md +15 -0
- data/docs/Unite.md +15 -0
- data/docs/UtilisateurApi.md +74 -0
- data/docs/ValidationError.md +22 -0
- data/docs/ValidationErrorDetail.md +26 -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 +1183 -0
- data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +256 -0
- data/lib/factpulse/api/chorus_pro_api.rb +1103 -0
- data/lib/factpulse/api/sant_api.rb +136 -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 +397 -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/helpers/client.rb +300 -0
- data/lib/factpulse/helpers/exceptions.rb +21 -0
- data/lib/factpulse/helpers.rb +13 -0
- data/lib/factpulse/models/adresse_electronique.rb +196 -0
- data/lib/factpulse/models/adresse_postale.rb +189 -0
- data/lib/factpulse/models/api_error.rb +205 -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 +215 -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/donnees_facture_simplifiees.rb +342 -0
- data/lib/factpulse/models/error_level.rb +40 -0
- data/lib/factpulse/models/error_source.rb +46 -0
- data/lib/factpulse/models/facture_enrichie_info.rb +348 -0
- data/lib/factpulse/models/facture_factur_x.rb +443 -0
- data/lib/factpulse/models/format_sortie.rb +40 -0
- data/lib/factpulse/models/fournisseur.rb +271 -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 +390 -0
- data/lib/factpulse/models/ligne_de_poste_montant_remise_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_a_payer.rb +104 -0
- data/lib/factpulse/models/montant_base_ht.rb +104 -0
- data/lib/factpulse/models/montant_ht_total.rb +104 -0
- data/lib/factpulse/models/montant_remise_globale_ttc.rb +104 -0
- data/lib/factpulse/models/montant_total.rb +272 -0
- data/lib/factpulse/models/montant_total_acompte.rb +104 -0
- data/lib/factpulse/models/montant_total_ligne_ht.rb +104 -0
- data/lib/factpulse/models/montant_ttc_total.rb +104 -0
- data/lib/factpulse/models/montant_tva.rb +104 -0
- data/lib/factpulse/models/montant_tva_ligne.rb +104 -0
- data/lib/factpulse/models/montant_tva_total.rb +104 -0
- data/lib/factpulse/models/montant_unitaire_ht.rb +104 -0
- data/lib/factpulse/models/note.rb +175 -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 +207 -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/piece_jointe_complementaire.rb +269 -0
- data/lib/factpulse/models/profil_api.rb +42 -0
- data/lib/factpulse/models/quantite.rb +104 -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_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/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 +388 -0
- data/lib/factpulse/models/soumettre_facture_response.rb +213 -0
- data/lib/factpulse/models/statut_celery.rb +43 -0
- data/lib/factpulse/models/statut_facture.rb +203 -0
- data/lib/factpulse/models/statut_tache.rb +226 -0
- data/lib/factpulse/models/structure_info.rb +274 -0
- data/lib/factpulse/models/tauxmanuel.rb +104 -0
- data/lib/factpulse/models/type_facture.rb +40 -0
- data/lib/factpulse/models/type_tva.rb +42 -0
- data/lib/factpulse/models/unite.rb +44 -0
- data/lib/factpulse/models/validation_error.rb +218 -0
- data/lib/factpulse/models/validation_error_detail.rb +245 -0
- data/lib/factpulse/models/validation_error_loc_inner.rb +103 -0
- data/lib/factpulse/version.rb +15 -0
- data/lib/factpulse.rb +133 -0
- metadata +345 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# FactPulse::RechercherStructureResponse
|
|
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
|
+
| **liste_structures** | [**Array<StructureInfo>**](StructureInfo.md) | | [optional] |
|
|
10
|
+
| **total** | **Integer** | Nombre total de résultats | [optional][default to 0] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'factpulse'
|
|
16
|
+
|
|
17
|
+
instance = FactPulse::RechercherStructureResponse.new(
|
|
18
|
+
code_retour: null,
|
|
19
|
+
libelle: null,
|
|
20
|
+
liste_structures: null,
|
|
21
|
+
total: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/References.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# FactPulse::References
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **devise_facture** | **String** | | [optional][default to 'EUR'] |
|
|
8
|
+
| **mode_paiement** | [**ModePaiement**](ModePaiement.md) | | |
|
|
9
|
+
| **type_facture** | [**TypeFacture**](TypeFacture.md) | | |
|
|
10
|
+
| **type_tva** | [**TypeTVA**](TypeTVA.md) | | |
|
|
11
|
+
| **numero_marche** | **String** | | [optional] |
|
|
12
|
+
| **motif_exoneration_tva** | **String** | | [optional] |
|
|
13
|
+
| **numero_bon_commande** | **String** | | [optional] |
|
|
14
|
+
| **numero_facture_origine** | **String** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'factpulse'
|
|
20
|
+
|
|
21
|
+
instance = FactPulse::References.new(
|
|
22
|
+
devise_facture: null,
|
|
23
|
+
mode_paiement: null,
|
|
24
|
+
type_facture: null,
|
|
25
|
+
type_tva: null,
|
|
26
|
+
numero_marche: null,
|
|
27
|
+
motif_exoneration_tva: null,
|
|
28
|
+
numero_bon_commande: null,
|
|
29
|
+
numero_facture_origine: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FactPulse::ReponseTache
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id_tache** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'factpulse'
|
|
13
|
+
|
|
14
|
+
instance = FactPulse::ReponseTache.new(
|
|
15
|
+
id_tache: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FactPulse::ReponseValidationErreur
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **detail** | **Array<String>** | Liste des erreurs de validation détectées. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'factpulse'
|
|
13
|
+
|
|
14
|
+
instance = FactPulse::ReponseValidationErreur.new(
|
|
15
|
+
detail: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FactPulse::ReponseValidationSucces
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **message** | **String** | Message confirmant la conformité du XML. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'factpulse'
|
|
13
|
+
|
|
14
|
+
instance = FactPulse::ReponseValidationSucces.new(
|
|
15
|
+
message: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# FactPulse::ResultatAFNOR
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **flow_id** | **String** | Identifiant du flux soumis | |
|
|
8
|
+
| **tracking_id** | **String** | | [optional] |
|
|
9
|
+
| **sha256** | **String** | Hash SHA-256 du fichier soumis | |
|
|
10
|
+
| **flow_syntax** | **String** | Syntaxe du flux | |
|
|
11
|
+
| **flow_profile** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'factpulse'
|
|
17
|
+
|
|
18
|
+
instance = FactPulse::ResultatAFNOR.new(
|
|
19
|
+
flow_id: null,
|
|
20
|
+
tracking_id: null,
|
|
21
|
+
sha256: null,
|
|
22
|
+
flow_syntax: null,
|
|
23
|
+
flow_profile: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::ResultatChorusPro
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **identifiant_facture_cpp** | **Integer** | ID Chorus Pro de la facture soumise | |
|
|
8
|
+
| **numero_flux_depot** | **String** | | [optional] |
|
|
9
|
+
| **piece_jointe_id** | **Integer** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::ResultatChorusPro.new(
|
|
17
|
+
identifiant_facture_cpp: null,
|
|
18
|
+
numero_flux_depot: null,
|
|
19
|
+
piece_jointe_id: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# FactPulse::ResultatValidationPDFAPI
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **est_conforme** | **Boolean** | True si le PDF est conforme à tous les critères (XML, PDF/A, XMP) | |
|
|
8
|
+
| **xml_present** | **Boolean** | True si un XML Factur-X est embarqué dans le PDF | |
|
|
9
|
+
| **xml_conforme** | **Boolean** | True si le XML Factur-X est conforme aux règles Schematron | |
|
|
10
|
+
| **profil_detecte** | **String** | | [optional] |
|
|
11
|
+
| **erreurs_xml** | **Array<String>** | Liste des erreurs de validation XML | [optional] |
|
|
12
|
+
| **pdfa_conforme** | **Boolean** | True si le PDF est conforme PDF/A | |
|
|
13
|
+
| **version_pdfa** | **String** | | [optional] |
|
|
14
|
+
| **methode_validation_pdfa** | **String** | Méthode utilisée pour la validation PDF/A (metadata ou verapdf) | [optional][default to 'metadata'] |
|
|
15
|
+
| **regles_validees** | **Integer** | | [optional] |
|
|
16
|
+
| **regles_echouees** | **Integer** | | [optional] |
|
|
17
|
+
| **erreurs_pdfa** | **Array<String>** | Liste des erreurs de conformité PDF/A | [optional] |
|
|
18
|
+
| **avertissements_pdfa** | **Array<String>** | Liste des avertissements PDF/A | [optional] |
|
|
19
|
+
| **xmp_present** | **Boolean** | True si des métadonnées XMP sont présentes | |
|
|
20
|
+
| **xmp_conforme_facturx** | **Boolean** | True si les métadonnées XMP contiennent des informations Factur-X | |
|
|
21
|
+
| **profil_xmp** | **String** | | [optional] |
|
|
22
|
+
| **version_xmp** | **String** | | [optional] |
|
|
23
|
+
| **erreurs_xmp** | **Array<String>** | Liste des erreurs de métadonnées XMP | [optional] |
|
|
24
|
+
| **metadonnees_xmp** | **Hash<String, Object>** | Métadonnées XMP extraites du PDF | [optional] |
|
|
25
|
+
| **est_signe** | **Boolean** | True si le PDF contient au moins une signature | |
|
|
26
|
+
| **nombre_signatures** | **Integer** | Nombre de signatures électroniques trouvées | [optional][default to 0] |
|
|
27
|
+
| **signatures** | [**Array<InformationSignatureAPI>**](InformationSignatureAPI.md) | Liste des signatures trouvées avec leurs informations | [optional] |
|
|
28
|
+
| **erreurs_signatures** | **Array<String>** | Liste des erreurs lors de l'analyse des signatures | [optional] |
|
|
29
|
+
| **message_resume** | **String** | Message résumant le résultat de la validation | |
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
require 'factpulse'
|
|
35
|
+
|
|
36
|
+
instance = FactPulse::ResultatValidationPDFAPI.new(
|
|
37
|
+
est_conforme: null,
|
|
38
|
+
xml_present: null,
|
|
39
|
+
xml_conforme: null,
|
|
40
|
+
profil_detecte: null,
|
|
41
|
+
erreurs_xml: null,
|
|
42
|
+
pdfa_conforme: null,
|
|
43
|
+
version_pdfa: null,
|
|
44
|
+
methode_validation_pdfa: null,
|
|
45
|
+
regles_validees: null,
|
|
46
|
+
regles_echouees: null,
|
|
47
|
+
erreurs_pdfa: null,
|
|
48
|
+
avertissements_pdfa: null,
|
|
49
|
+
xmp_present: null,
|
|
50
|
+
xmp_conforme_facturx: null,
|
|
51
|
+
profil_xmp: null,
|
|
52
|
+
version_xmp: null,
|
|
53
|
+
erreurs_xmp: null,
|
|
54
|
+
metadonnees_xmp: null,
|
|
55
|
+
est_signe: null,
|
|
56
|
+
nombre_signatures: null,
|
|
57
|
+
signatures: null,
|
|
58
|
+
erreurs_signatures: null,
|
|
59
|
+
message_resume: null
|
|
60
|
+
)
|
|
61
|
+
```
|
|
62
|
+
|
data/docs/SantApi.md
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# FactPulse::SantApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**healthcheck_healthcheck_get**](SantApi.md#healthcheck_healthcheck_get) | **GET** /healthcheck | Endpoint de healthcheck pour Docker |
|
|
8
|
+
| [**racine_get**](SantApi.md#racine_get) | **GET** / | Vérifier l'état de l'API |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## healthcheck_healthcheck_get
|
|
12
|
+
|
|
13
|
+
> Object healthcheck_healthcheck_get
|
|
14
|
+
|
|
15
|
+
Endpoint de healthcheck pour Docker
|
|
16
|
+
|
|
17
|
+
Endpoint de healthcheck pour Docker et les load balancers. Utile pour : - Docker healthcheck - Kubernetes liveness/readiness probes - Load balancers (Nginx, HAProxy) - Monitoring de disponibilité - Déploiement zero downtime Retourne un code 200 si l'API est opérationnelle.
|
|
18
|
+
|
|
19
|
+
### Examples
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'time'
|
|
23
|
+
require 'factpulse'
|
|
24
|
+
|
|
25
|
+
api_instance = FactPulse::SantApi.new
|
|
26
|
+
|
|
27
|
+
begin
|
|
28
|
+
# Endpoint de healthcheck pour Docker
|
|
29
|
+
result = api_instance.healthcheck_healthcheck_get
|
|
30
|
+
p result
|
|
31
|
+
rescue FactPulse::ApiError => e
|
|
32
|
+
puts "Error when calling SantApi->healthcheck_healthcheck_get: #{e}"
|
|
33
|
+
end
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
#### Using the healthcheck_healthcheck_get_with_http_info variant
|
|
37
|
+
|
|
38
|
+
This returns an Array which contains the response data, status code and headers.
|
|
39
|
+
|
|
40
|
+
> <Array(Object, Integer, Hash)> healthcheck_healthcheck_get_with_http_info
|
|
41
|
+
|
|
42
|
+
```ruby
|
|
43
|
+
begin
|
|
44
|
+
# Endpoint de healthcheck pour Docker
|
|
45
|
+
data, status_code, headers = api_instance.healthcheck_healthcheck_get_with_http_info
|
|
46
|
+
p status_code # => 2xx
|
|
47
|
+
p headers # => { ... }
|
|
48
|
+
p data # => Object
|
|
49
|
+
rescue FactPulse::ApiError => e
|
|
50
|
+
puts "Error when calling SantApi->healthcheck_healthcheck_get_with_http_info: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
This endpoint does not need any parameter.
|
|
57
|
+
|
|
58
|
+
### Return type
|
|
59
|
+
|
|
60
|
+
**Object**
|
|
61
|
+
|
|
62
|
+
### Authorization
|
|
63
|
+
|
|
64
|
+
No authorization required
|
|
65
|
+
|
|
66
|
+
### HTTP request headers
|
|
67
|
+
|
|
68
|
+
- **Content-Type**: Not defined
|
|
69
|
+
- **Accept**: application/json
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
## racine_get
|
|
73
|
+
|
|
74
|
+
> Object racine_get
|
|
75
|
+
|
|
76
|
+
Vérifier l'état de l'API
|
|
77
|
+
|
|
78
|
+
Endpoint de health check pour vérifier que l'API répond. Utile pour : - Monitoring de disponibilité - Tests d'intégration - Load balancers
|
|
79
|
+
|
|
80
|
+
### Examples
|
|
81
|
+
|
|
82
|
+
```ruby
|
|
83
|
+
require 'time'
|
|
84
|
+
require 'factpulse'
|
|
85
|
+
|
|
86
|
+
api_instance = FactPulse::SantApi.new
|
|
87
|
+
|
|
88
|
+
begin
|
|
89
|
+
# Vérifier l'état de l'API
|
|
90
|
+
result = api_instance.racine_get
|
|
91
|
+
p result
|
|
92
|
+
rescue FactPulse::ApiError => e
|
|
93
|
+
puts "Error when calling SantApi->racine_get: #{e}"
|
|
94
|
+
end
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
#### Using the racine_get_with_http_info variant
|
|
98
|
+
|
|
99
|
+
This returns an Array which contains the response data, status code and headers.
|
|
100
|
+
|
|
101
|
+
> <Array(Object, Integer, Hash)> racine_get_with_http_info
|
|
102
|
+
|
|
103
|
+
```ruby
|
|
104
|
+
begin
|
|
105
|
+
# Vérifier l'état de l'API
|
|
106
|
+
data, status_code, headers = api_instance.racine_get_with_http_info
|
|
107
|
+
p status_code # => 2xx
|
|
108
|
+
p headers # => { ... }
|
|
109
|
+
p data # => Object
|
|
110
|
+
rescue FactPulse::ApiError => e
|
|
111
|
+
puts "Error when calling SantApi->racine_get_with_http_info: #{e}"
|
|
112
|
+
end
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Parameters
|
|
116
|
+
|
|
117
|
+
This endpoint does not need any parameter.
|
|
118
|
+
|
|
119
|
+
### Return type
|
|
120
|
+
|
|
121
|
+
**Object**
|
|
122
|
+
|
|
123
|
+
### Authorization
|
|
124
|
+
|
|
125
|
+
No authorization required
|
|
126
|
+
|
|
127
|
+
### HTTP request headers
|
|
128
|
+
|
|
129
|
+
- **Content-Type**: Not defined
|
|
130
|
+
- **Accept**: application/json
|
|
131
|
+
|
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,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** | [**FactureEnrichieInfo**](FactureEnrichieInfo.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** | [**MontantHtTotal**](MontantHtTotal.md) | | |
|
|
15
|
+
| **montant_tva** | [**MontantTva**](MontantTva.md) | | |
|
|
16
|
+
| **montant_ttc_total** | [**MontantTtcTotal**](MontantTtcTotal.md) | | |
|
|
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** | [**StatutCelery**](StatutCelery.md) | Statut Celery de la tâche (PENDING, STARTED, SUCCESS, FAILURE, RETRY) | |
|
|
9
|
+
| **resultat** | **Hash<String, Object>** | | [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
|
+
|
data/docs/Tauxmanuel.md
ADDED