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.
Files changed (205) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +28 -0
  3. data/Gemfile +9 -0
  4. data/Gemfile.lock +74 -0
  5. data/LICENSE +21 -0
  6. data/README.md +207 -0
  7. data/Rakefile +10 -0
  8. data/docs/AFNORPDPPAApi.md +69 -0
  9. data/docs/AFNORPDPPADirectoryServiceApi.md +1313 -0
  10. data/docs/AFNORPDPPAFlowServiceApi.md +258 -0
  11. data/docs/APIError.md +22 -0
  12. data/docs/AdresseElectronique.md +20 -0
  13. data/docs/AdressePostale.md +26 -0
  14. data/docs/CadreDeFacturation.md +22 -0
  15. data/docs/CategorieTVA.md +15 -0
  16. data/docs/CertificateInfoResponse.md +40 -0
  17. data/docs/ChorusProApi.md +1125 -0
  18. data/docs/ChorusProCredentials.md +26 -0
  19. data/docs/CodeCadreFacturation.md +15 -0
  20. data/docs/CodeRaisonReduction.md +15 -0
  21. data/docs/ConsulterFactureRequest.md +20 -0
  22. data/docs/ConsulterFactureResponse.md +34 -0
  23. data/docs/ConsulterStructureRequest.md +22 -0
  24. data/docs/ConsulterStructureResponse.md +34 -0
  25. data/docs/CredentialsAFNOR.md +22 -0
  26. data/docs/CredentialsChorusPro.md +26 -0
  27. data/docs/Destinataire.md +28 -0
  28. data/docs/Destination.md +79 -0
  29. data/docs/DestinationAFNOR.md +24 -0
  30. data/docs/DestinationChorusPro.md +20 -0
  31. data/docs/DonneesFactureSimplifiees.md +34 -0
  32. data/docs/ErrorLevel.md +15 -0
  33. data/docs/ErrorSource.md +15 -0
  34. data/docs/FactureEnrichieInfo.md +32 -0
  35. data/docs/FactureFacturX.md +46 -0
  36. data/docs/FormatSortie.md +15 -0
  37. data/docs/Fournisseur.md +36 -0
  38. data/docs/GenerateCertificateRequest.md +38 -0
  39. data/docs/GenerateCertificateResponse.md +32 -0
  40. data/docs/HTTPValidationError.md +18 -0
  41. data/docs/InformationSignatureAPI.md +28 -0
  42. data/docs/LigneDePoste.md +46 -0
  43. data/docs/LigneDePosteMontantRemiseHt.md +15 -0
  44. data/docs/LigneDePosteTauxTvaManuel.md +15 -0
  45. data/docs/LigneDeTVA.md +26 -0
  46. data/docs/ModeDepot.md +15 -0
  47. data/docs/ModePaiement.md +15 -0
  48. data/docs/MontantAPayer.md +15 -0
  49. data/docs/MontantBaseHt.md +15 -0
  50. data/docs/MontantHtTotal.md +15 -0
  51. data/docs/MontantRemiseGlobaleTtc.md +15 -0
  52. data/docs/MontantTotal.md +30 -0
  53. data/docs/MontantTotalAcompte.md +15 -0
  54. data/docs/MontantTotalLigneHt.md +15 -0
  55. data/docs/MontantTtcTotal.md +15 -0
  56. data/docs/MontantTva.md +15 -0
  57. data/docs/MontantTvaLigne.md +15 -0
  58. data/docs/MontantTvaTotal.md +15 -0
  59. data/docs/MontantUnitaireHt.md +15 -0
  60. data/docs/Note.md +20 -0
  61. data/docs/ObtenirIdChorusProRequest.md +22 -0
  62. data/docs/ObtenirIdChorusProResponse.md +24 -0
  63. data/docs/OptionsProcessing.md +24 -0
  64. data/docs/PDFFacturXInfo.md +22 -0
  65. data/docs/ParametresSignature.md +34 -0
  66. data/docs/ParametresStructure.md +22 -0
  67. data/docs/PieceJointeComplementaire.md +26 -0
  68. data/docs/ProfilAPI.md +15 -0
  69. data/docs/Quantite.md +15 -0
  70. data/docs/RechercherServicesResponse.md +24 -0
  71. data/docs/RechercherStructureRequest.md +26 -0
  72. data/docs/RechercherStructureResponse.md +24 -0
  73. data/docs/References.md +32 -0
  74. data/docs/ReponseTache.md +18 -0
  75. data/docs/ReponseValidationErreur.md +18 -0
  76. data/docs/ReponseValidationSucces.md +18 -0
  77. data/docs/ResultatAFNOR.md +26 -0
  78. data/docs/ResultatChorusPro.md +22 -0
  79. data/docs/ResultatValidationPDFAPI.md +62 -0
  80. data/docs/SantApi.md +131 -0
  81. data/docs/SchemeID.md +15 -0
  82. data/docs/ServiceStructure.md +24 -0
  83. data/docs/SignatureInfo.md +22 -0
  84. data/docs/SoumettreFactureCompleteRequest.md +26 -0
  85. data/docs/SoumettreFactureCompleteResponse.md +34 -0
  86. data/docs/SoumettreFactureRequest.md +46 -0
  87. data/docs/SoumettreFactureResponse.md +24 -0
  88. data/docs/StatutCelery.md +15 -0
  89. data/docs/StatutFacture.md +22 -0
  90. data/docs/StatutTache.md +22 -0
  91. data/docs/StructureInfo.md +26 -0
  92. data/docs/Tauxmanuel.md +15 -0
  93. data/docs/TraitementFactureApi.md +831 -0
  94. data/docs/TypeFacture.md +15 -0
  95. data/docs/TypeTVA.md +15 -0
  96. data/docs/Unite.md +15 -0
  97. data/docs/UtilisateurApi.md +74 -0
  98. data/docs/ValidationError.md +22 -0
  99. data/docs/ValidationErrorDetail.md +26 -0
  100. data/docs/ValidationErrorLocInner.md +15 -0
  101. data/factpulse.gemspec +39 -0
  102. data/git_push.sh +57 -0
  103. data/lib/factpulse/api/afnorpdppa_api.rb +79 -0
  104. data/lib/factpulse/api/afnorpdppa_directory_service_api.rb +1183 -0
  105. data/lib/factpulse/api/afnorpdppa_flow_service_api.rb +256 -0
  106. data/lib/factpulse/api/chorus_pro_api.rb +1103 -0
  107. data/lib/factpulse/api/sant_api.rb +136 -0
  108. data/lib/factpulse/api/traitement_facture_api.rb +835 -0
  109. data/lib/factpulse/api/utilisateur_api.rb +79 -0
  110. data/lib/factpulse/api_client.rb +397 -0
  111. data/lib/factpulse/api_error.rb +58 -0
  112. data/lib/factpulse/api_model_base.rb +88 -0
  113. data/lib/factpulse/configuration.rb +308 -0
  114. data/lib/factpulse/helpers/client.rb +300 -0
  115. data/lib/factpulse/helpers/exceptions.rb +21 -0
  116. data/lib/factpulse/helpers.rb +13 -0
  117. data/lib/factpulse/models/adresse_electronique.rb +196 -0
  118. data/lib/factpulse/models/adresse_postale.rb +189 -0
  119. data/lib/factpulse/models/api_error.rb +205 -0
  120. data/lib/factpulse/models/cadre_de_facturation.rb +207 -0
  121. data/lib/factpulse/models/categorie_tva.rb +47 -0
  122. data/lib/factpulse/models/certificate_info_response.rb +446 -0
  123. data/lib/factpulse/models/chorus_pro_credentials.rb +259 -0
  124. data/lib/factpulse/models/code_cadre_facturation.rb +42 -0
  125. data/lib/factpulse/models/code_raison_reduction.rb +45 -0
  126. data/lib/factpulse/models/consulter_facture_request.rb +176 -0
  127. data/lib/factpulse/models/consulter_facture_response.rb +261 -0
  128. data/lib/factpulse/models/consulter_structure_request.rb +188 -0
  129. data/lib/factpulse/models/consulter_structure_response.rb +261 -0
  130. data/lib/factpulse/models/credentials_afnor.rb +169 -0
  131. data/lib/factpulse/models/credentials_chorus_pro.rb +191 -0
  132. data/lib/factpulse/models/destinataire.rb +215 -0
  133. data/lib/factpulse/models/destination.rb +56 -0
  134. data/lib/factpulse/models/destination_afnor.rb +228 -0
  135. data/lib/factpulse/models/destination_chorus_pro.rb +194 -0
  136. data/lib/factpulse/models/donnees_facture_simplifiees.rb +342 -0
  137. data/lib/factpulse/models/error_level.rb +40 -0
  138. data/lib/factpulse/models/error_source.rb +46 -0
  139. data/lib/factpulse/models/facture_enrichie_info.rb +348 -0
  140. data/lib/factpulse/models/facture_factur_x.rb +443 -0
  141. data/lib/factpulse/models/format_sortie.rb +40 -0
  142. data/lib/factpulse/models/fournisseur.rb +271 -0
  143. data/lib/factpulse/models/generate_certificate_request.rb +323 -0
  144. data/lib/factpulse/models/generate_certificate_response.rb +254 -0
  145. data/lib/factpulse/models/http_validation_error.rb +149 -0
  146. data/lib/factpulse/models/information_signature_api.rb +216 -0
  147. data/lib/factpulse/models/ligne_de_poste.rb +390 -0
  148. data/lib/factpulse/models/ligne_de_poste_montant_remise_ht.rb +104 -0
  149. data/lib/factpulse/models/ligne_de_poste_taux_tva_manuel.rb +104 -0
  150. data/lib/factpulse/models/ligne_de_tva.rb +242 -0
  151. data/lib/factpulse/models/mode_depot.rb +41 -0
  152. data/lib/factpulse/models/mode_paiement.rb +44 -0
  153. data/lib/factpulse/models/montant_a_payer.rb +104 -0
  154. data/lib/factpulse/models/montant_base_ht.rb +104 -0
  155. data/lib/factpulse/models/montant_ht_total.rb +104 -0
  156. data/lib/factpulse/models/montant_remise_globale_ttc.rb +104 -0
  157. data/lib/factpulse/models/montant_total.rb +272 -0
  158. data/lib/factpulse/models/montant_total_acompte.rb +104 -0
  159. data/lib/factpulse/models/montant_total_ligne_ht.rb +104 -0
  160. data/lib/factpulse/models/montant_ttc_total.rb +104 -0
  161. data/lib/factpulse/models/montant_tva.rb +104 -0
  162. data/lib/factpulse/models/montant_tva_ligne.rb +104 -0
  163. data/lib/factpulse/models/montant_tva_total.rb +104 -0
  164. data/lib/factpulse/models/montant_unitaire_ht.rb +104 -0
  165. data/lib/factpulse/models/note.rb +175 -0
  166. data/lib/factpulse/models/obtenir_id_chorus_pro_request.rb +188 -0
  167. data/lib/factpulse/models/obtenir_id_chorus_pro_response.rb +230 -0
  168. data/lib/factpulse/models/options_processing.rb +207 -0
  169. data/lib/factpulse/models/parametres_signature.rb +235 -0
  170. data/lib/factpulse/models/parametres_structure.rb +175 -0
  171. data/lib/factpulse/models/pdf_factur_x_info.rb +205 -0
  172. data/lib/factpulse/models/piece_jointe_complementaire.rb +269 -0
  173. data/lib/factpulse/models/profil_api.rb +42 -0
  174. data/lib/factpulse/models/quantite.rb +104 -0
  175. data/lib/factpulse/models/rechercher_services_response.rb +214 -0
  176. data/lib/factpulse/models/rechercher_structure_request.rb +191 -0
  177. data/lib/factpulse/models/rechercher_structure_response.rb +216 -0
  178. data/lib/factpulse/models/references.rb +290 -0
  179. data/lib/factpulse/models/reponse_tache.rb +165 -0
  180. data/lib/factpulse/models/reponse_validation_erreur.rb +167 -0
  181. data/lib/factpulse/models/reponse_validation_succes.rb +165 -0
  182. data/lib/factpulse/models/resultat_afnor.rb +240 -0
  183. data/lib/factpulse/models/resultat_chorus_pro.rb +186 -0
  184. data/lib/factpulse/models/resultat_validation_pdfapi.rb +523 -0
  185. data/lib/factpulse/models/scheme_id.rb +43 -0
  186. data/lib/factpulse/models/service_structure.rb +247 -0
  187. data/lib/factpulse/models/signature_info.rb +186 -0
  188. data/lib/factpulse/models/soumettre_facture_complete_request.rb +239 -0
  189. data/lib/factpulse/models/soumettre_facture_complete_response.rb +355 -0
  190. data/lib/factpulse/models/soumettre_facture_request.rb +388 -0
  191. data/lib/factpulse/models/soumettre_facture_response.rb +213 -0
  192. data/lib/factpulse/models/statut_celery.rb +43 -0
  193. data/lib/factpulse/models/statut_facture.rb +203 -0
  194. data/lib/factpulse/models/statut_tache.rb +226 -0
  195. data/lib/factpulse/models/structure_info.rb +274 -0
  196. data/lib/factpulse/models/tauxmanuel.rb +104 -0
  197. data/lib/factpulse/models/type_facture.rb +40 -0
  198. data/lib/factpulse/models/type_tva.rb +42 -0
  199. data/lib/factpulse/models/unite.rb +44 -0
  200. data/lib/factpulse/models/validation_error.rb +218 -0
  201. data/lib/factpulse/models/validation_error_detail.rb +245 -0
  202. data/lib/factpulse/models/validation_error_loc_inner.rb +103 -0
  203. data/lib/factpulse/version.rb +15 -0
  204. data/lib/factpulse.rb +133 -0
  205. metadata +345 -0
@@ -0,0 +1,1125 @@
1
+ # FactPulse::ChorusProApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
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 | Ajouter une pièce jointe |
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 | Compléter une facture suspendue (Fournisseur) |
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 | Consulter le statut d'une facture |
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 | Consulter les détails d'une structure |
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 | Lister les services d'une structure |
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 | Utilitaire : Obtenir l'ID Chorus Pro depuis un 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 | Rechercher factures reçues (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 | Rechercher factures émises (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 | Rechercher des structures Chorus Pro |
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 | Recycler une facture (Fournisseur) |
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 | Soumettre une facture à 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 | Télécharger un groupe de factures |
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 | Traiter une facture reçue (Destinataire) |
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 | Consulter une facture (Valideur) |
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 | Rechercher factures à valider (Valideur) |
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 | Valider ou refuser une facture (Valideur) |
23
+
24
+
25
+ ## ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post
26
+
27
+ > Object ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post(request_body)
28
+
29
+ Ajouter une pièce jointe
30
+
31
+ Ajoute une pièce jointe au compte utilisateur courant. **Taille max** : 10 Mo par fichier **Payload exemple** : ```json { \"pieceJointeFichier\": \"JVBERi0xLjQKJeLjz9MKNSAwIG9iago8P...\", \"pieceJointeNom\": \"bon_commande.pdf\", \"pieceJointeTypeMime\": \"application/pdf\", \"pieceJointeExtension\": \"PDF\" } ``` **Retour** : L'ID de la pièce jointe (`pieceJointeIdFichier`) à utiliser ensuite dans `/factures/completer`. **Extensions acceptées** : PDF, JPG, PNG, ZIP, XML, etc.
32
+
33
+ ### Examples
34
+
35
+ ```ruby
36
+ require 'time'
37
+ require 'factpulse'
38
+ # setup authorization
39
+ FactPulse.configure do |config|
40
+ # Configure Bearer authorization: HTTPBearer
41
+ config.access_token = 'YOUR_BEARER_TOKEN'
42
+ end
43
+
44
+ api_instance = FactPulse::ChorusProApi.new
45
+ request_body = { key: 3.56} # Hash<String, Object> |
46
+
47
+ begin
48
+ # Ajouter une pièce jointe
49
+ result = api_instance.ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post(request_body)
50
+ p result
51
+ rescue FactPulse::ApiError => e
52
+ puts "Error when calling ChorusProApi->ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post: #{e}"
53
+ end
54
+ ```
55
+
56
+ #### Using the ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info variant
57
+
58
+ This returns an Array which contains the response data, status code and headers.
59
+
60
+ > <Array(Object, Integer, Hash)> ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info(request_body)
61
+
62
+ ```ruby
63
+ begin
64
+ # Ajouter une pièce jointe
65
+ data, status_code, headers = api_instance.ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info(request_body)
66
+ p status_code # => 2xx
67
+ p headers # => { ... }
68
+ p data # => Object
69
+ rescue FactPulse::ApiError => e
70
+ puts "Error when calling ChorusProApi->ajouter_fichier_api_v1_chorus_pro_transverses_ajouter_fichier_post_with_http_info: #{e}"
71
+ end
72
+ ```
73
+
74
+ ### Parameters
75
+
76
+ | Name | Type | Description | Notes |
77
+ | ---- | ---- | ----------- | ----- |
78
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
79
+
80
+ ### Return type
81
+
82
+ **Object**
83
+
84
+ ### Authorization
85
+
86
+ [HTTPBearer](../README.md#HTTPBearer)
87
+
88
+ ### HTTP request headers
89
+
90
+ - **Content-Type**: application/json
91
+ - **Accept**: application/json
92
+
93
+
94
+ ## completer_facture_api_v1_chorus_pro_factures_completer_post
95
+
96
+ > Object completer_facture_api_v1_chorus_pro_factures_completer_post(request_body)
97
+
98
+ Compléter une facture suspendue (Fournisseur)
99
+
100
+ Complète une facture au statut SUSPENDUE en ajoutant des pièces jointes ou un commentaire. **Statut requis** : SUSPENDUE **Actions possibles** : - Ajouter des pièces jointes (justificatifs, bons de commande, etc.) - Modifier le commentaire **Payload exemple** : ```json { \"identifiantFactureCPP\": 12345, \"commentaire\": \"Voici les justificatifs demandés\", \"listePiecesJointes\": [ { \"pieceJointeIdFichier\": 98765, \"pieceJointeNom\": \"bon_commande.pdf\" } ] } ``` **Note** : Les pièces jointes doivent d'abord être uploadées via `/transverses/ajouter-fichier`. **Après complétion** : La facture repasse au statut MISE_A_DISPOSITION.
101
+
102
+ ### Examples
103
+
104
+ ```ruby
105
+ require 'time'
106
+ require 'factpulse'
107
+ # setup authorization
108
+ FactPulse.configure do |config|
109
+ # Configure Bearer authorization: HTTPBearer
110
+ config.access_token = 'YOUR_BEARER_TOKEN'
111
+ end
112
+
113
+ api_instance = FactPulse::ChorusProApi.new
114
+ request_body = { key: 3.56} # Hash<String, Object> |
115
+
116
+ begin
117
+ # Compléter une facture suspendue (Fournisseur)
118
+ result = api_instance.completer_facture_api_v1_chorus_pro_factures_completer_post(request_body)
119
+ p result
120
+ rescue FactPulse::ApiError => e
121
+ puts "Error when calling ChorusProApi->completer_facture_api_v1_chorus_pro_factures_completer_post: #{e}"
122
+ end
123
+ ```
124
+
125
+ #### Using the completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info variant
126
+
127
+ This returns an Array which contains the response data, status code and headers.
128
+
129
+ > <Array(Object, Integer, Hash)> completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info(request_body)
130
+
131
+ ```ruby
132
+ begin
133
+ # Compléter une facture suspendue (Fournisseur)
134
+ data, status_code, headers = api_instance.completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info(request_body)
135
+ p status_code # => 2xx
136
+ p headers # => { ... }
137
+ p data # => Object
138
+ rescue FactPulse::ApiError => e
139
+ puts "Error when calling ChorusProApi->completer_facture_api_v1_chorus_pro_factures_completer_post_with_http_info: #{e}"
140
+ end
141
+ ```
142
+
143
+ ### Parameters
144
+
145
+ | Name | Type | Description | Notes |
146
+ | ---- | ---- | ----------- | ----- |
147
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
148
+
149
+ ### Return type
150
+
151
+ **Object**
152
+
153
+ ### Authorization
154
+
155
+ [HTTPBearer](../README.md#HTTPBearer)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: application/json
160
+ - **Accept**: application/json
161
+
162
+
163
+ ## consulter_facture_api_v1_chorus_pro_factures_consulter_post
164
+
165
+ > <ConsulterFactureResponse> consulter_facture_api_v1_chorus_pro_factures_consulter_post(consulter_facture_request)
166
+
167
+ Consulter le statut d'une facture
168
+
169
+ Récupère les informations et le statut actuel d'une facture soumise à Chorus Pro. **Retour** : - Numéro et date de facture - Montant TTC - **Statut courant** : SOUMISE, VALIDEE, REJETEE, SUSPENDUE, MANDATEE, MISE_EN_PAIEMENT, etc. - Structure destinataire **Cas d'usage** : - Suivre l'évolution du traitement d'une facture - Vérifier si une facture a été validée ou rejetée - Obtenir la date de mise en paiement **Polling** : Appelez cet endpoint régulièrement pour suivre l'évolution du statut.
170
+
171
+ ### Examples
172
+
173
+ ```ruby
174
+ require 'time'
175
+ require 'factpulse'
176
+ # setup authorization
177
+ FactPulse.configure do |config|
178
+ # Configure Bearer authorization: HTTPBearer
179
+ config.access_token = 'YOUR_BEARER_TOKEN'
180
+ end
181
+
182
+ api_instance = FactPulse::ChorusProApi.new
183
+ consulter_facture_request = FactPulse::ConsulterFactureRequest.new({identifiant_facture_cpp: 37}) # ConsulterFactureRequest |
184
+
185
+ begin
186
+ # Consulter le statut d'une facture
187
+ result = api_instance.consulter_facture_api_v1_chorus_pro_factures_consulter_post(consulter_facture_request)
188
+ p result
189
+ rescue FactPulse::ApiError => e
190
+ puts "Error when calling ChorusProApi->consulter_facture_api_v1_chorus_pro_factures_consulter_post: #{e}"
191
+ end
192
+ ```
193
+
194
+ #### Using the consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info variant
195
+
196
+ This returns an Array which contains the response data, status code and headers.
197
+
198
+ > <Array(<ConsulterFactureResponse>, Integer, Hash)> consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(consulter_facture_request)
199
+
200
+ ```ruby
201
+ begin
202
+ # Consulter le statut d'une facture
203
+ data, status_code, headers = api_instance.consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info(consulter_facture_request)
204
+ p status_code # => 2xx
205
+ p headers # => { ... }
206
+ p data # => <ConsulterFactureResponse>
207
+ rescue FactPulse::ApiError => e
208
+ puts "Error when calling ChorusProApi->consulter_facture_api_v1_chorus_pro_factures_consulter_post_with_http_info: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ | Name | Type | Description | Notes |
215
+ | ---- | ---- | ----------- | ----- |
216
+ | **consulter_facture_request** | [**ConsulterFactureRequest**](ConsulterFactureRequest.md) | | |
217
+
218
+ ### Return type
219
+
220
+ [**ConsulterFactureResponse**](ConsulterFactureResponse.md)
221
+
222
+ ### Authorization
223
+
224
+ [HTTPBearer](../README.md#HTTPBearer)
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: application/json
229
+ - **Accept**: application/json
230
+
231
+
232
+ ## consulter_structure_api_v1_chorus_pro_structures_consulter_post
233
+
234
+ > <ConsulterStructureResponse> consulter_structure_api_v1_chorus_pro_structures_consulter_post(consulter_structure_request)
235
+
236
+ Consulter les détails d'une structure
237
+
238
+ Récupère les informations détaillées d'une structure Chorus Pro. **Retour** : - Raison sociale - Numéro de TVA intracommunautaire - Email de contact - **Paramètres obligatoires** : Indique si le code service et/ou numéro d'engagement sont requis pour soumettre une facture **Étape typique** : Appelée après `rechercher-structures` pour savoir quels champs sont obligatoires avant de soumettre une facture.
239
+
240
+ ### Examples
241
+
242
+ ```ruby
243
+ require 'time'
244
+ require 'factpulse'
245
+ # setup authorization
246
+ FactPulse.configure do |config|
247
+ # Configure Bearer authorization: HTTPBearer
248
+ config.access_token = 'YOUR_BEARER_TOKEN'
249
+ end
250
+
251
+ api_instance = FactPulse::ChorusProApi.new
252
+ consulter_structure_request = FactPulse::ConsulterStructureRequest.new({id_structure_cpp: 37}) # ConsulterStructureRequest |
253
+
254
+ begin
255
+ # Consulter les détails d'une structure
256
+ result = api_instance.consulter_structure_api_v1_chorus_pro_structures_consulter_post(consulter_structure_request)
257
+ p result
258
+ rescue FactPulse::ApiError => e
259
+ puts "Error when calling ChorusProApi->consulter_structure_api_v1_chorus_pro_structures_consulter_post: #{e}"
260
+ end
261
+ ```
262
+
263
+ #### Using the consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info variant
264
+
265
+ This returns an Array which contains the response data, status code and headers.
266
+
267
+ > <Array(<ConsulterStructureResponse>, Integer, Hash)> consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(consulter_structure_request)
268
+
269
+ ```ruby
270
+ begin
271
+ # Consulter les détails d'une structure
272
+ data, status_code, headers = api_instance.consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info(consulter_structure_request)
273
+ p status_code # => 2xx
274
+ p headers # => { ... }
275
+ p data # => <ConsulterStructureResponse>
276
+ rescue FactPulse::ApiError => e
277
+ puts "Error when calling ChorusProApi->consulter_structure_api_v1_chorus_pro_structures_consulter_post_with_http_info: #{e}"
278
+ end
279
+ ```
280
+
281
+ ### Parameters
282
+
283
+ | Name | Type | Description | Notes |
284
+ | ---- | ---- | ----------- | ----- |
285
+ | **consulter_structure_request** | [**ConsulterStructureRequest**](ConsulterStructureRequest.md) | | |
286
+
287
+ ### Return type
288
+
289
+ [**ConsulterStructureResponse**](ConsulterStructureResponse.md)
290
+
291
+ ### Authorization
292
+
293
+ [HTTPBearer](../README.md#HTTPBearer)
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: application/json
298
+ - **Accept**: application/json
299
+
300
+
301
+ ## lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get
302
+
303
+ > <RechercherServicesResponse> lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get(id_structure_cpp)
304
+
305
+ Lister les services d'une structure
306
+
307
+ Récupère la liste des services actifs d'une structure publique. **Cas d'usage** : - Lister les services disponibles pour une administration - Vérifier qu'un code service existe avant de soumettre une facture **Retour** : - Liste des services avec leur code, libellé et statut (actif/inactif)
308
+
309
+ ### Examples
310
+
311
+ ```ruby
312
+ require 'time'
313
+ require 'factpulse'
314
+ # setup authorization
315
+ FactPulse.configure do |config|
316
+ # Configure Bearer authorization: HTTPBearer
317
+ config.access_token = 'YOUR_BEARER_TOKEN'
318
+ end
319
+
320
+ api_instance = FactPulse::ChorusProApi.new
321
+ id_structure_cpp = 56 # Integer |
322
+
323
+ begin
324
+ # Lister les services d'une structure
325
+ result = api_instance.lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get(id_structure_cpp)
326
+ p result
327
+ rescue FactPulse::ApiError => e
328
+ puts "Error when calling ChorusProApi->lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get: #{e}"
329
+ end
330
+ ```
331
+
332
+ #### Using the lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info variant
333
+
334
+ This returns an Array which contains the response data, status code and headers.
335
+
336
+ > <Array(<RechercherServicesResponse>, Integer, Hash)> lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info(id_structure_cpp)
337
+
338
+ ```ruby
339
+ begin
340
+ # Lister les services d'une structure
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
+ p status_code # => 2xx
343
+ p headers # => { ... }
344
+ p data # => <RechercherServicesResponse>
345
+ rescue FactPulse::ApiError => e
346
+ puts "Error when calling ChorusProApi->lister_services_structure_api_v1_chorus_pro_structures_id_structure_cpp_services_get_with_http_info: #{e}"
347
+ end
348
+ ```
349
+
350
+ ### Parameters
351
+
352
+ | Name | Type | Description | Notes |
353
+ | ---- | ---- | ----------- | ----- |
354
+ | **id_structure_cpp** | **Integer** | | |
355
+
356
+ ### Return type
357
+
358
+ [**RechercherServicesResponse**](RechercherServicesResponse.md)
359
+
360
+ ### Authorization
361
+
362
+ [HTTPBearer](../README.md#HTTPBearer)
363
+
364
+ ### HTTP request headers
365
+
366
+ - **Content-Type**: Not defined
367
+ - **Accept**: application/json
368
+
369
+
370
+ ## obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post
371
+
372
+ > <ObtenirIdChorusProResponse> obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(obtenir_id_chorus_pro_request)
373
+
374
+ Utilitaire : Obtenir l'ID Chorus Pro depuis un SIRET
375
+
376
+ **Utilitaire pratique** pour obtenir l'ID Chorus Pro d'une structure à partir de son SIRET. Cette fonction wrapper combine : 1. Recherche de la structure par SIRET 2. Extraction de l'`id_structure_cpp` si une seule structure est trouvée **Retour** : - `id_structure_cpp` : ID Chorus Pro (0 si non trouvé ou si plusieurs résultats) - `designation_structure` : Nom de la structure (si trouvée) - `message` : Message explicatif **Cas d'usage** : - Raccourci pour obtenir directement l'ID Chorus Pro avant de soumettre une facture - Alternative simplifiée à `rechercher-structures` + extraction manuelle de l'ID **Note** : Si plusieurs structures correspondent au SIRET (rare), retourne 0 et un message d'erreur.
377
+
378
+ ### Examples
379
+
380
+ ```ruby
381
+ require 'time'
382
+ require 'factpulse'
383
+ # setup authorization
384
+ FactPulse.configure do |config|
385
+ # Configure Bearer authorization: HTTPBearer
386
+ config.access_token = 'YOUR_BEARER_TOKEN'
387
+ end
388
+
389
+ api_instance = FactPulse::ChorusProApi.new
390
+ obtenir_id_chorus_pro_request = FactPulse::ObtenirIdChorusProRequest.new({siret: 'siret_example'}) # ObtenirIdChorusProRequest |
391
+
392
+ begin
393
+ # Utilitaire : Obtenir l'ID Chorus Pro depuis un SIRET
394
+ result = api_instance.obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post(obtenir_id_chorus_pro_request)
395
+ p result
396
+ rescue FactPulse::ApiError => e
397
+ puts "Error when calling ChorusProApi->obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post: #{e}"
398
+ end
399
+ ```
400
+
401
+ #### Using the obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info variant
402
+
403
+ This returns an Array which contains the response data, status code and headers.
404
+
405
+ > <Array(<ObtenirIdChorusProResponse>, Integer, Hash)> obtenir_id_chorus_pro_depuis_siret_api_v1_chorus_pro_structures_obtenir_id_depuis_siret_post_with_http_info(obtenir_id_chorus_pro_request)
406
+
407
+ ```ruby
408
+ begin
409
+ # Utilitaire : Obtenir l'ID Chorus Pro depuis un 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(obtenir_id_chorus_pro_request)
411
+ p status_code # => 2xx
412
+ p headers # => { ... }
413
+ p data # => <ObtenirIdChorusProResponse>
414
+ rescue FactPulse::ApiError => e
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
+ end
417
+ ```
418
+
419
+ ### Parameters
420
+
421
+ | Name | Type | Description | Notes |
422
+ | ---- | ---- | ----------- | ----- |
423
+ | **obtenir_id_chorus_pro_request** | [**ObtenirIdChorusProRequest**](ObtenirIdChorusProRequest.md) | | |
424
+
425
+ ### Return type
426
+
427
+ [**ObtenirIdChorusProResponse**](ObtenirIdChorusProResponse.md)
428
+
429
+ ### Authorization
430
+
431
+ [HTTPBearer](../README.md#HTTPBearer)
432
+
433
+ ### HTTP request headers
434
+
435
+ - **Content-Type**: application/json
436
+ - **Accept**: application/json
437
+
438
+
439
+ ## rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post
440
+
441
+ > Object rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post(request_body)
442
+
443
+ Rechercher factures reçues (Destinataire)
444
+
445
+ Recherche les factures reçues par le destinataire connecté. **Filtres** : - Téléchargée / non téléchargée - Dates de réception - Statut (MISE_A_DISPOSITION, SUSPENDUE, etc.) - Fournisseur **Indicateur utile** : `factureTelechargeeParDestinataire` permet de savoir si la facture a déjà été téléchargée.
446
+
447
+ ### Examples
448
+
449
+ ```ruby
450
+ require 'time'
451
+ require 'factpulse'
452
+ # setup authorization
453
+ FactPulse.configure do |config|
454
+ # Configure Bearer authorization: HTTPBearer
455
+ config.access_token = 'YOUR_BEARER_TOKEN'
456
+ end
457
+
458
+ api_instance = FactPulse::ChorusProApi.new
459
+ request_body = { key: 3.56} # Hash<String, Object> |
460
+
461
+ begin
462
+ # Rechercher factures reçues (Destinataire)
463
+ result = api_instance.rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post(request_body)
464
+ p result
465
+ rescue FactPulse::ApiError => e
466
+ puts "Error when calling ChorusProApi->rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post: #{e}"
467
+ end
468
+ ```
469
+
470
+ #### Using the rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info variant
471
+
472
+ This returns an Array which contains the response data, status code and headers.
473
+
474
+ > <Array(Object, Integer, Hash)> rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info(request_body)
475
+
476
+ ```ruby
477
+ begin
478
+ # Rechercher factures reçues (Destinataire)
479
+ data, status_code, headers = api_instance.rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info(request_body)
480
+ p status_code # => 2xx
481
+ p headers # => { ... }
482
+ p data # => Object
483
+ rescue FactPulse::ApiError => e
484
+ puts "Error when calling ChorusProApi->rechercher_factures_destinataire_api_v1_chorus_pro_factures_rechercher_destinataire_post_with_http_info: #{e}"
485
+ end
486
+ ```
487
+
488
+ ### Parameters
489
+
490
+ | Name | Type | Description | Notes |
491
+ | ---- | ---- | ----------- | ----- |
492
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
493
+
494
+ ### Return type
495
+
496
+ **Object**
497
+
498
+ ### Authorization
499
+
500
+ [HTTPBearer](../README.md#HTTPBearer)
501
+
502
+ ### HTTP request headers
503
+
504
+ - **Content-Type**: application/json
505
+ - **Accept**: application/json
506
+
507
+
508
+ ## rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post
509
+
510
+ > Object rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post(request_body)
511
+
512
+ Rechercher factures émises (Fournisseur)
513
+
514
+ Recherche les factures émises par le fournisseur connecté. **Filtres disponibles** : - Numéro de facture - Dates (début/fin) - Statut - Structure destinataire - Montant **Cas d'usage** : - Suivi des factures émises - Vérification des statuts - Export pour comptabilité
515
+
516
+ ### Examples
517
+
518
+ ```ruby
519
+ require 'time'
520
+ require 'factpulse'
521
+ # setup authorization
522
+ FactPulse.configure do |config|
523
+ # Configure Bearer authorization: HTTPBearer
524
+ config.access_token = 'YOUR_BEARER_TOKEN'
525
+ end
526
+
527
+ api_instance = FactPulse::ChorusProApi.new
528
+ request_body = { key: 3.56} # Hash<String, Object> |
529
+
530
+ begin
531
+ # Rechercher factures émises (Fournisseur)
532
+ result = api_instance.rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post(request_body)
533
+ p result
534
+ rescue FactPulse::ApiError => e
535
+ puts "Error when calling ChorusProApi->rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post: #{e}"
536
+ end
537
+ ```
538
+
539
+ #### Using the rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info variant
540
+
541
+ This returns an Array which contains the response data, status code and headers.
542
+
543
+ > <Array(Object, Integer, Hash)> rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info(request_body)
544
+
545
+ ```ruby
546
+ begin
547
+ # Rechercher factures émises (Fournisseur)
548
+ data, status_code, headers = api_instance.rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info(request_body)
549
+ p status_code # => 2xx
550
+ p headers # => { ... }
551
+ p data # => Object
552
+ rescue FactPulse::ApiError => e
553
+ puts "Error when calling ChorusProApi->rechercher_factures_fournisseur_api_v1_chorus_pro_factures_rechercher_fournisseur_post_with_http_info: #{e}"
554
+ end
555
+ ```
556
+
557
+ ### Parameters
558
+
559
+ | Name | Type | Description | Notes |
560
+ | ---- | ---- | ----------- | ----- |
561
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
562
+
563
+ ### Return type
564
+
565
+ **Object**
566
+
567
+ ### Authorization
568
+
569
+ [HTTPBearer](../README.md#HTTPBearer)
570
+
571
+ ### HTTP request headers
572
+
573
+ - **Content-Type**: application/json
574
+ - **Accept**: application/json
575
+
576
+
577
+ ## rechercher_structures_api_v1_chorus_pro_structures_rechercher_post
578
+
579
+ > <RechercherStructureResponse> rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(rechercher_structure_request)
580
+
581
+ Rechercher des structures Chorus Pro
582
+
583
+ Recherche des structures (entreprises, administrations) enregistrées sur Chorus Pro. **Cas d'usage** : - Trouver l'ID Chorus Pro d'une structure à partir de son SIRET - Vérifier si une structure est enregistrée sur Chorus Pro - Lister les structures correspondant à des critères **Filtres disponibles** : - Identifiant (SIRET, SIREN, etc.) - Raison sociale - Type d'identifiant - Structures privées uniquement **Étape typique** : Appelée avant `soumettre-facture` pour obtenir l'`id_structure_cpp` du destinataire.
584
+
585
+ ### Examples
586
+
587
+ ```ruby
588
+ require 'time'
589
+ require 'factpulse'
590
+ # setup authorization
591
+ FactPulse.configure do |config|
592
+ # Configure Bearer authorization: HTTPBearer
593
+ config.access_token = 'YOUR_BEARER_TOKEN'
594
+ end
595
+
596
+ api_instance = FactPulse::ChorusProApi.new
597
+ rechercher_structure_request = FactPulse::RechercherStructureRequest.new # RechercherStructureRequest |
598
+
599
+ begin
600
+ # Rechercher des structures Chorus Pro
601
+ result = api_instance.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post(rechercher_structure_request)
602
+ p result
603
+ rescue FactPulse::ApiError => e
604
+ puts "Error when calling ChorusProApi->rechercher_structures_api_v1_chorus_pro_structures_rechercher_post: #{e}"
605
+ end
606
+ ```
607
+
608
+ #### Using the rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info variant
609
+
610
+ This returns an Array which contains the response data, status code and headers.
611
+
612
+ > <Array(<RechercherStructureResponse>, Integer, Hash)> rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(rechercher_structure_request)
613
+
614
+ ```ruby
615
+ begin
616
+ # Rechercher des structures Chorus Pro
617
+ data, status_code, headers = api_instance.rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info(rechercher_structure_request)
618
+ p status_code # => 2xx
619
+ p headers # => { ... }
620
+ p data # => <RechercherStructureResponse>
621
+ rescue FactPulse::ApiError => e
622
+ puts "Error when calling ChorusProApi->rechercher_structures_api_v1_chorus_pro_structures_rechercher_post_with_http_info: #{e}"
623
+ end
624
+ ```
625
+
626
+ ### Parameters
627
+
628
+ | Name | Type | Description | Notes |
629
+ | ---- | ---- | ----------- | ----- |
630
+ | **rechercher_structure_request** | [**RechercherStructureRequest**](RechercherStructureRequest.md) | | |
631
+
632
+ ### Return type
633
+
634
+ [**RechercherStructureResponse**](RechercherStructureResponse.md)
635
+
636
+ ### Authorization
637
+
638
+ [HTTPBearer](../README.md#HTTPBearer)
639
+
640
+ ### HTTP request headers
641
+
642
+ - **Content-Type**: application/json
643
+ - **Accept**: application/json
644
+
645
+
646
+ ## recycler_facture_api_v1_chorus_pro_factures_recycler_post
647
+
648
+ > Object recycler_facture_api_v1_chorus_pro_factures_recycler_post(request_body)
649
+
650
+ Recycler une facture (Fournisseur)
651
+
652
+ Recycle une facture au statut A_RECYCLER en modifiant les données d'acheminement. **Statut requis** : A_RECYCLER **Champs modifiables** : - Destinataire (`idStructureCPP`) - Code service - Numéro d'engagement **Cas d'usage** : - Erreur de destinataire - Changement de service facturation - Mise à jour du numéro d'engagement **Payload exemple** : ```json { \"identifiantFactureCPP\": 12345, \"idStructureCPP\": 67890, \"codeService\": \"SERVICE_01\", \"numeroEngagement\": \"ENG2024001\" } ``` **Note** : La facture conserve son numéro et ses montants, seuls les champs d'acheminement changent.
653
+
654
+ ### Examples
655
+
656
+ ```ruby
657
+ require 'time'
658
+ require 'factpulse'
659
+ # setup authorization
660
+ FactPulse.configure do |config|
661
+ # Configure Bearer authorization: HTTPBearer
662
+ config.access_token = 'YOUR_BEARER_TOKEN'
663
+ end
664
+
665
+ api_instance = FactPulse::ChorusProApi.new
666
+ request_body = { key: 3.56} # Hash<String, Object> |
667
+
668
+ begin
669
+ # Recycler une facture (Fournisseur)
670
+ result = api_instance.recycler_facture_api_v1_chorus_pro_factures_recycler_post(request_body)
671
+ p result
672
+ rescue FactPulse::ApiError => e
673
+ puts "Error when calling ChorusProApi->recycler_facture_api_v1_chorus_pro_factures_recycler_post: #{e}"
674
+ end
675
+ ```
676
+
677
+ #### Using the recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info variant
678
+
679
+ This returns an Array which contains the response data, status code and headers.
680
+
681
+ > <Array(Object, Integer, Hash)> recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info(request_body)
682
+
683
+ ```ruby
684
+ begin
685
+ # Recycler une facture (Fournisseur)
686
+ data, status_code, headers = api_instance.recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info(request_body)
687
+ p status_code # => 2xx
688
+ p headers # => { ... }
689
+ p data # => Object
690
+ rescue FactPulse::ApiError => e
691
+ puts "Error when calling ChorusProApi->recycler_facture_api_v1_chorus_pro_factures_recycler_post_with_http_info: #{e}"
692
+ end
693
+ ```
694
+
695
+ ### Parameters
696
+
697
+ | Name | Type | Description | Notes |
698
+ | ---- | ---- | ----------- | ----- |
699
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
700
+
701
+ ### Return type
702
+
703
+ **Object**
704
+
705
+ ### Authorization
706
+
707
+ [HTTPBearer](../README.md#HTTPBearer)
708
+
709
+ ### HTTP request headers
710
+
711
+ - **Content-Type**: application/json
712
+ - **Accept**: application/json
713
+
714
+
715
+ ## soumettre_facture_api_v1_chorus_pro_factures_soumettre_post
716
+
717
+ > <SoumettreFactureResponse> soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(soumettre_facture_request)
718
+
719
+ Soumettre une facture à Chorus Pro
720
+
721
+ Soumet une facture électronique à une structure publique via Chorus Pro. **📋 Workflow complet** : 1. **Uploader le PDF Factur-X** via `/transverses/ajouter-fichier` → récupérer `pieceJointeId` 2. **Obtenir l'ID structure** via `/structures/rechercher` ou `/structures/obtenir-id-depuis-siret` 3. **Vérifier les paramètres obligatoires** via `/structures/consulter` 4. **Soumettre la facture** avec le `piece_jointe_principale_id` obtenu à l'étape 1 **Pré-requis** : 1. Avoir l'`id_structure_cpp` du destinataire (via `/structures/rechercher`) 2. Connaître les paramètres obligatoires (via `/structures/consulter`) : - Code service si `code_service_doit_etre_renseigne=true` - Numéro d'engagement si `numero_ej_doit_etre_renseigne=true` 3. Avoir uploadé le PDF Factur-X (via `/transverses/ajouter-fichier`) **Format attendu** : - `piece_jointe_principale_id` : ID retourné par `/transverses/ajouter-fichier` - Montants : Chaînes de caractères avec 2 décimales (ex: \"1250.50\") - Dates : Format ISO 8601 (YYYY-MM-DD) **Retour** : - `identifiant_facture_cpp` : ID Chorus Pro de la facture créée - `numero_flux_depot` : Numéro de suivi du dépôt **Statuts possibles après soumission** : - SOUMISE : En attente de validation - VALIDEE : Validée par le destinataire - REJETEE : Rejetée (erreur de données ou refus métier) - SUSPENDUE : En attente d'informations complémentaires **Note** : Utilisez `/factures/consulter` pour suivre l'évolution du statut.
722
+
723
+ ### Examples
724
+
725
+ ```ruby
726
+ require 'time'
727
+ require 'factpulse'
728
+ # setup authorization
729
+ FactPulse.configure do |config|
730
+ # Configure Bearer authorization: HTTPBearer
731
+ config.access_token = 'YOUR_BEARER_TOKEN'
732
+ end
733
+
734
+ api_instance = FactPulse::ChorusProApi.new
735
+ soumettre_facture_request = FactPulse::SoumettreFactureRequest.new({numero_facture: 'numero_facture_example', date_facture: 'date_facture_example', id_structure_cpp: 37, montant_ht_total: FactPulse::MontantHtTotal.new, montant_tva: FactPulse::MontantTva.new, montant_ttc_total: FactPulse::MontantTtcTotal.new}) # SoumettreFactureRequest |
736
+
737
+ begin
738
+ # Soumettre une facture à Chorus Pro
739
+ result = api_instance.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post(soumettre_facture_request)
740
+ p result
741
+ rescue FactPulse::ApiError => e
742
+ puts "Error when calling ChorusProApi->soumettre_facture_api_v1_chorus_pro_factures_soumettre_post: #{e}"
743
+ end
744
+ ```
745
+
746
+ #### Using the soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info variant
747
+
748
+ This returns an Array which contains the response data, status code and headers.
749
+
750
+ > <Array(<SoumettreFactureResponse>, Integer, Hash)> soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(soumettre_facture_request)
751
+
752
+ ```ruby
753
+ begin
754
+ # Soumettre une facture à Chorus Pro
755
+ data, status_code, headers = api_instance.soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info(soumettre_facture_request)
756
+ p status_code # => 2xx
757
+ p headers # => { ... }
758
+ p data # => <SoumettreFactureResponse>
759
+ rescue FactPulse::ApiError => e
760
+ puts "Error when calling ChorusProApi->soumettre_facture_api_v1_chorus_pro_factures_soumettre_post_with_http_info: #{e}"
761
+ end
762
+ ```
763
+
764
+ ### Parameters
765
+
766
+ | Name | Type | Description | Notes |
767
+ | ---- | ---- | ----------- | ----- |
768
+ | **soumettre_facture_request** | [**SoumettreFactureRequest**](SoumettreFactureRequest.md) | | |
769
+
770
+ ### Return type
771
+
772
+ [**SoumettreFactureResponse**](SoumettreFactureResponse.md)
773
+
774
+ ### Authorization
775
+
776
+ [HTTPBearer](../README.md#HTTPBearer)
777
+
778
+ ### HTTP request headers
779
+
780
+ - **Content-Type**: application/json
781
+ - **Accept**: application/json
782
+
783
+
784
+ ## telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post
785
+
786
+ > Object telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post(request_body)
787
+
788
+ Télécharger un groupe de factures
789
+
790
+ Télécharge une ou plusieurs factures (max 10 recommandé) avec leurs pièces jointes. **Formats disponibles** : - PDF : Fichier PDF uniquement - XML : Fichier XML uniquement - ZIP : Archive contenant PDF + XML + pièces jointes **Taille maximale** : 120 Mo par téléchargement **Payload exemple** : ```json { \"listeIdentifiantsFactureCPP\": [12345, 12346], \"inclurePiecesJointes\": true, \"formatFichier\": \"ZIP\" } ``` **Retour** : Le fichier est encodé en base64 dans le champ `fichierBase64`. **Note** : Le flag `factureTelechargeeParDestinataire` est mis à jour automatiquement.
791
+
792
+ ### Examples
793
+
794
+ ```ruby
795
+ require 'time'
796
+ require 'factpulse'
797
+ # setup authorization
798
+ FactPulse.configure do |config|
799
+ # Configure Bearer authorization: HTTPBearer
800
+ config.access_token = 'YOUR_BEARER_TOKEN'
801
+ end
802
+
803
+ api_instance = FactPulse::ChorusProApi.new
804
+ request_body = { key: 3.56} # Hash<String, Object> |
805
+
806
+ begin
807
+ # Télécharger un groupe de factures
808
+ result = api_instance.telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post(request_body)
809
+ p result
810
+ rescue FactPulse::ApiError => e
811
+ puts "Error when calling ChorusProApi->telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post: #{e}"
812
+ end
813
+ ```
814
+
815
+ #### Using the telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info variant
816
+
817
+ This returns an Array which contains the response data, status code and headers.
818
+
819
+ > <Array(Object, Integer, Hash)> telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info(request_body)
820
+
821
+ ```ruby
822
+ begin
823
+ # Télécharger un groupe de factures
824
+ data, status_code, headers = api_instance.telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info(request_body)
825
+ p status_code # => 2xx
826
+ p headers # => { ... }
827
+ p data # => Object
828
+ rescue FactPulse::ApiError => e
829
+ puts "Error when calling ChorusProApi->telecharger_groupe_factures_api_v1_chorus_pro_factures_telecharger_groupe_post_with_http_info: #{e}"
830
+ end
831
+ ```
832
+
833
+ ### Parameters
834
+
835
+ | Name | Type | Description | Notes |
836
+ | ---- | ---- | ----------- | ----- |
837
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
838
+
839
+ ### Return type
840
+
841
+ **Object**
842
+
843
+ ### Authorization
844
+
845
+ [HTTPBearer](../README.md#HTTPBearer)
846
+
847
+ ### HTTP request headers
848
+
849
+ - **Content-Type**: application/json
850
+ - **Accept**: application/json
851
+
852
+
853
+ ## traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post
854
+
855
+ > Object traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post(request_body)
856
+
857
+ Traiter une facture reçue (Destinataire)
858
+
859
+ Change le statut d'une facture reçue. **Statuts possibles** : - MISE_A_DISPOSITION : Facture acceptée - SUSPENDUE : En attente d'informations complémentaires (motif obligatoire) - REJETEE : Facture refusée (motif obligatoire) - MANDATEE : Facture mandatée - MISE_EN_PAIEMENT : Facture en cours de paiement - COMPTABILISEE : Facture comptabilisée - MISE_A_DISPOSITION_COMPTABLE : Mise à disposition comptable - A_RECYCLER : À recycler - COMPLETEE : Complétée - SERVICE-FAIT : Service fait - PRISE_EN_COMPTE_DESTINATAIRE : Prise en compte - TRANSMISE_MOA : Transmise à la MOA **Payload exemple** : ```json { \"identifiantFactureCPP\": 12345, \"nouveauStatut\": \"REJETEE\", \"motifRejet\": \"Facture en double\", \"commentaire\": \"Facture déjà reçue sous la référence ABC123\" } ``` **Règles** : - Un motif est **obligatoire** pour SUSPENDUE et REJETEE - Seuls certains statuts sont autorisés selon le statut actuel de la facture
860
+
861
+ ### Examples
862
+
863
+ ```ruby
864
+ require 'time'
865
+ require 'factpulse'
866
+ # setup authorization
867
+ FactPulse.configure do |config|
868
+ # Configure Bearer authorization: HTTPBearer
869
+ config.access_token = 'YOUR_BEARER_TOKEN'
870
+ end
871
+
872
+ api_instance = FactPulse::ChorusProApi.new
873
+ request_body = { key: 3.56} # Hash<String, Object> |
874
+
875
+ begin
876
+ # Traiter une facture reçue (Destinataire)
877
+ result = api_instance.traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post(request_body)
878
+ p result
879
+ rescue FactPulse::ApiError => e
880
+ puts "Error when calling ChorusProApi->traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post: #{e}"
881
+ end
882
+ ```
883
+
884
+ #### Using the traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post_with_http_info variant
885
+
886
+ This returns an Array which contains the response data, status code and headers.
887
+
888
+ > <Array(Object, Integer, Hash)> traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post_with_http_info(request_body)
889
+
890
+ ```ruby
891
+ begin
892
+ # Traiter une facture reçue (Destinataire)
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
+ p status_code # => 2xx
895
+ p headers # => { ... }
896
+ p data # => Object
897
+ rescue FactPulse::ApiError => e
898
+ puts "Error when calling ChorusProApi->traiter_facture_recue_api_v1_chorus_pro_factures_traiter_facture_recue_post_with_http_info: #{e}"
899
+ end
900
+ ```
901
+
902
+ ### Parameters
903
+
904
+ | Name | Type | Description | Notes |
905
+ | ---- | ---- | ----------- | ----- |
906
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
907
+
908
+ ### Return type
909
+
910
+ **Object**
911
+
912
+ ### Authorization
913
+
914
+ [HTTPBearer](../README.md#HTTPBearer)
915
+
916
+ ### HTTP request headers
917
+
918
+ - **Content-Type**: application/json
919
+ - **Accept**: application/json
920
+
921
+
922
+ ## valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post
923
+
924
+ > Object valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post(request_body)
925
+
926
+ Consulter une facture (Valideur)
927
+
928
+ ### Examples
929
+
930
+ ```ruby
931
+ require 'time'
932
+ require 'factpulse'
933
+ # setup authorization
934
+ FactPulse.configure do |config|
935
+ # Configure Bearer authorization: HTTPBearer
936
+ config.access_token = 'YOUR_BEARER_TOKEN'
937
+ end
938
+
939
+ api_instance = FactPulse::ChorusProApi.new
940
+ request_body = { key: 3.56} # Hash<String, Object> |
941
+
942
+ begin
943
+ # Consulter une facture (Valideur)
944
+ result = api_instance.valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post(request_body)
945
+ p result
946
+ rescue FactPulse::ApiError => e
947
+ puts "Error when calling ChorusProApi->valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post: #{e}"
948
+ end
949
+ ```
950
+
951
+ #### Using the valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info variant
952
+
953
+ This returns an Array which contains the response data, status code and headers.
954
+
955
+ > <Array(Object, Integer, Hash)> valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info(request_body)
956
+
957
+ ```ruby
958
+ begin
959
+ # Consulter une facture (Valideur)
960
+ data, status_code, headers = api_instance.valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info(request_body)
961
+ p status_code # => 2xx
962
+ p headers # => { ... }
963
+ p data # => Object
964
+ rescue FactPulse::ApiError => e
965
+ puts "Error when calling ChorusProApi->valideur_consulter_facture_api_v1_chorus_pro_factures_valideur_consulter_post_with_http_info: #{e}"
966
+ end
967
+ ```
968
+
969
+ ### Parameters
970
+
971
+ | Name | Type | Description | Notes |
972
+ | ---- | ---- | ----------- | ----- |
973
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
974
+
975
+ ### Return type
976
+
977
+ **Object**
978
+
979
+ ### Authorization
980
+
981
+ [HTTPBearer](../README.md#HTTPBearer)
982
+
983
+ ### HTTP request headers
984
+
985
+ - **Content-Type**: application/json
986
+ - **Accept**: application/json
987
+
988
+
989
+ ## valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post
990
+
991
+ > Object valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post(request_body)
992
+
993
+ Rechercher factures à valider (Valideur)
994
+
995
+ Recherche les factures en attente de validation par le valideur connecté. **Rôle** : Valideur dans le circuit de validation interne. **Filtres** : Dates, structure, service, etc.
996
+
997
+ ### Examples
998
+
999
+ ```ruby
1000
+ require 'time'
1001
+ require 'factpulse'
1002
+ # setup authorization
1003
+ FactPulse.configure do |config|
1004
+ # Configure Bearer authorization: HTTPBearer
1005
+ config.access_token = 'YOUR_BEARER_TOKEN'
1006
+ end
1007
+
1008
+ api_instance = FactPulse::ChorusProApi.new
1009
+ request_body = { key: 3.56} # Hash<String, Object> |
1010
+
1011
+ begin
1012
+ # Rechercher factures à valider (Valideur)
1013
+ result = api_instance.valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post(request_body)
1014
+ p result
1015
+ rescue FactPulse::ApiError => e
1016
+ puts "Error when calling ChorusProApi->valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post: #{e}"
1017
+ end
1018
+ ```
1019
+
1020
+ #### Using the valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info variant
1021
+
1022
+ This returns an Array which contains the response data, status code and headers.
1023
+
1024
+ > <Array(Object, Integer, Hash)> valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info(request_body)
1025
+
1026
+ ```ruby
1027
+ begin
1028
+ # Rechercher factures à valider (Valideur)
1029
+ data, status_code, headers = api_instance.valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info(request_body)
1030
+ p status_code # => 2xx
1031
+ p headers # => { ... }
1032
+ p data # => Object
1033
+ rescue FactPulse::ApiError => e
1034
+ puts "Error when calling ChorusProApi->valideur_rechercher_factures_api_v1_chorus_pro_factures_valideur_rechercher_post_with_http_info: #{e}"
1035
+ end
1036
+ ```
1037
+
1038
+ ### Parameters
1039
+
1040
+ | Name | Type | Description | Notes |
1041
+ | ---- | ---- | ----------- | ----- |
1042
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
1043
+
1044
+ ### Return type
1045
+
1046
+ **Object**
1047
+
1048
+ ### Authorization
1049
+
1050
+ [HTTPBearer](../README.md#HTTPBearer)
1051
+
1052
+ ### HTTP request headers
1053
+
1054
+ - **Content-Type**: application/json
1055
+ - **Accept**: application/json
1056
+
1057
+
1058
+ ## valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post
1059
+
1060
+ > Object valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post(request_body)
1061
+
1062
+ Valider ou refuser une facture (Valideur)
1063
+
1064
+ Valide ou refuse une facture en attente de validation. **Actions** : - Valider : La facture passe au statut suivant du circuit - Refuser : La facture est rejetée (motif obligatoire)
1065
+
1066
+ ### Examples
1067
+
1068
+ ```ruby
1069
+ require 'time'
1070
+ require 'factpulse'
1071
+ # setup authorization
1072
+ FactPulse.configure do |config|
1073
+ # Configure Bearer authorization: HTTPBearer
1074
+ config.access_token = 'YOUR_BEARER_TOKEN'
1075
+ end
1076
+
1077
+ api_instance = FactPulse::ChorusProApi.new
1078
+ request_body = { key: 3.56} # Hash<String, Object> |
1079
+
1080
+ begin
1081
+ # Valider ou refuser une facture (Valideur)
1082
+ result = api_instance.valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post(request_body)
1083
+ p result
1084
+ rescue FactPulse::ApiError => e
1085
+ puts "Error when calling ChorusProApi->valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post: #{e}"
1086
+ end
1087
+ ```
1088
+
1089
+ #### Using the valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info variant
1090
+
1091
+ This returns an Array which contains the response data, status code and headers.
1092
+
1093
+ > <Array(Object, Integer, Hash)> valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info(request_body)
1094
+
1095
+ ```ruby
1096
+ begin
1097
+ # Valider ou refuser une facture (Valideur)
1098
+ data, status_code, headers = api_instance.valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info(request_body)
1099
+ p status_code # => 2xx
1100
+ p headers # => { ... }
1101
+ p data # => Object
1102
+ rescue FactPulse::ApiError => e
1103
+ puts "Error when calling ChorusProApi->valideur_traiter_facture_api_v1_chorus_pro_factures_valideur_traiter_post_with_http_info: #{e}"
1104
+ end
1105
+ ```
1106
+
1107
+ ### Parameters
1108
+
1109
+ | Name | Type | Description | Notes |
1110
+ | ---- | ---- | ----------- | ----- |
1111
+ | **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) | | |
1112
+
1113
+ ### Return type
1114
+
1115
+ **Object**
1116
+
1117
+ ### Authorization
1118
+
1119
+ [HTTPBearer](../README.md#HTTPBearer)
1120
+
1121
+ ### HTTP request headers
1122
+
1123
+ - **Content-Type**: application/json
1124
+ - **Accept**: application/json
1125
+