-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathClient.php
More file actions
951 lines (923 loc) · 67.3 KB
/
Client.php
File metadata and controls
951 lines (923 loc) · 67.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
<?php
namespace Qdequippe\Pappers\Api;
use Http\Client\Common\Plugin\AddHostPlugin;
use Http\Client\Common\Plugin\AddPathPlugin;
use Http\Client\Common\PluginClient;
use Http\Discovery\Psr17FactoryDiscovery;
use Http\Discovery\Psr18ClientDiscovery;
use Psr\Http\Message\ResponseInterface;
use Qdequippe\Pappers\Api\Endpoint\Association;
use Qdequippe\Pappers\Api\Endpoint\Cartographie;
use Qdequippe\Pappers\Api\Endpoint\ComptesAnnuels;
use Qdequippe\Pappers\Api\Endpoint\Conformite;
use Qdequippe\Pappers\Api\Endpoint\DocumentAvisSituationInsee;
use Qdequippe\Pappers\Api\Endpoint\DocumentBeneficiairesEffectifs;
use Qdequippe\Pappers\Api\Endpoint\DocumentExtraitInpi;
use Qdequippe\Pappers\Api\Endpoint\DocumentExtraitPappers;
use Qdequippe\Pappers\Api\Endpoint\DocumentScoringFinancier;
use Qdequippe\Pappers\Api\Endpoint\DocumentScoringNonFinancier;
use Qdequippe\Pappers\Api\Endpoint\DocumentStatus;
use Qdequippe\Pappers\Api\Endpoint\DocumentTelechargement;
use Qdequippe\Pappers\Api\Endpoint\Entreprise;
use Qdequippe\Pappers\Api\Endpoint\Recherche;
use Qdequippe\Pappers\Api\Endpoint\RechercheBeneficiaires;
use Qdequippe\Pappers\Api\Endpoint\RechercheDirigeants;
use Qdequippe\Pappers\Api\Endpoint\RechercheDocuments;
use Qdequippe\Pappers\Api\Endpoint\RecherchePublications;
use Qdequippe\Pappers\Api\Endpoint\Suggestions;
use Qdequippe\Pappers\Api\Endpoint\SuiviJetons;
use Qdequippe\Pappers\Api\Endpoint\SurveillanceDirigeant;
use Qdequippe\Pappers\Api\Endpoint\SurveillanceEntreprise;
use Qdequippe\Pappers\Api\Endpoint\SurveillanceListeInformations;
use Qdequippe\Pappers\Api\Endpoint\SurveillanceNotificationsDelete;
use Qdequippe\Pappers\Api\Model\ListeInformationsPostBody;
use Qdequippe\Pappers\Api\Normalizer\JaneObjectNormalizer;
use Symfony\Component\Serializer\Encoder\JsonDecode;
use Symfony\Component\Serializer\Encoder\JsonEncode;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
use Symfony\Component\Serializer\Serializer;
class Client extends Runtime\Client\Client
{
/**
* Vous devez fournir soit le SIREN, soit le SIRET.
*
* Si vous indiquez le SIREN, tous les établissements associés à ce SIREN seront renvoyés dans la clé `etablissements`.
*
* Si vous indiquez le SIRET, seul l'établissement associé sera renvoyé dans la clé `etablissement`
*
* > ⚠️ **Attention : Certaines entreprises sont en diffusion partielle auprès de l'Insee**
* >
* > Ce statut est signalé par le champ `diffusable=false`.
* >
* > Les champs suivants peuvent alors devenir nullable : `nom_entreprise` ; `denomination` ; `nom` ; `prenom` ; `sexe` ; `nom_usage` ; `nom_patronymique` ; `code_postal` ; `numero_voie` ; `indice_repetition` ; `type_voie` ; `libelle_voie` ; `complement_adresse` ; `adresse_ligne_1` ; `adresse_ligne_2`.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* @var string $siret SIRET de l'entreprise
* @var string $format_publications_bodacc Format attendu pour les publications BODACC. Valeur par défaut : `"objet"`.
* @var bool $validite_tva_intracommunautaire Si vrai, le champ validite_tva_intracommunautaire du retour indiquera si le numéro de tva est valide auprès de la Commission européenne. Valeur par défaut : `false`.
* @var bool $publications_bodacc_brutes Pappers traite les publications BODACC afin de supprimer les publications périmée. Si vrai, le retour inclura les publications bodacc sans traitement. Valeur par défaut : `false`.
* @var bool $beneficiaires_effectifs_complets Si vrai, la requête se lancera avec un accès complet au registre des bénéficiaires effectifs. Nécessite une habilitation.
* @var string $champs_supplementaires Liste des champs supplémentaires à inclure dans le retour. Certains champs peuvent entraîner une consommation de crédits supplémentaires.
*
* Champs supplémentaires disponibles :
* - `sites_internet` : 1 crédit supplémentaire si disponible
* - `telephone` : 3 crédits supplémentaires si disponible
* - `email` : 3 crédits supplémentaires si disponible
* - `lien_linkedin` : 3 crédits supplémentaires si disponible
* - `enseigne_1` : gratuit
* - `enseigne_2` : gratuit
* - `enseigne_3` : gratuit
* - `distribution_speciale` : gratuit
* - `code_cedex` : gratuit
* - `libelle_cedex` : gratuit
* - `code_commune` : gratuit
* - `code_region` : gratuit
* - `region` : gratuit
* - `code_departement` : gratuit
* - `departement` : gratuit
* - `nomenclature_code_naf` : gratuit
* - `labels` : gratuit
* - `labels:orias` : 0.5 crédit supplémentaire
* - `labels:cci` : 0.5 crédit supplémentaire
* - `micro_entreprise` : gratuit
* - `sanctions` : 1 crédit supplémentaire
* - `personne_politiquement_exposee` : 1 crédit supplémentaire
* - `deces` : 0.5 crédit supplémentaire
* - `scoring_financier` : 30 crédits supplémentaires
* - `scoring_non_financier` : 30 crédits supplémentaires
* - `categorie_entreprise` : gratuit
* - `motif_cessation` : gratuit
* - `nom_personne_physique` : gratuit
* - `representants_legaux` : gratuit
* - `entreprises_dirigees` : 1 crédit supplémentaire si disponible
* - `observations` : 0.5 crédit supplémentaire
* - `decisions` : 5 crédits supplémentaires si disponible (si l'entreprise n'a pas de décision, 0.5 crédit supplémentaire)
* - `parcelles_detenues`: 5 crédits supplémentaires si disponible
* - `appels_offres_gagnes`, `appels_offres_lances`: 2 crédits supplémentaires au total (même si les deux champs sont demandés), si disponible
* - `entreprises_citees`: 3 crédits supplémentaires si disponible
* - `marques`, `brevets`, `dessins`: 1 crédit supplémentaire au total (même si plusieurs de ces trois champs sont demandés), si disponible
* - `informations_boursieres`: 5 crédits supplémentaires si disponible
* - `informations_boursieres:documents`: 10 crédits supplémentaires si disponible (donc un total de 15 crédits supplémentaires car ce champ inclut également le champ `informations_boursieres`)
* - `finances_estimations` : 5 crédits supplémentaires si disponible
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\EntrepriseFiche|null : ResponseInterface)
*
* @throws Exception\EntrepriseBadRequestException
* @throws Exception\EntrepriseUnauthorizedException
* @throws Exception\EntrepriseNotFoundException
*/
public function entreprise(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new Entreprise($queryParameters), $fetch);
}
/**
* Vous devez fournir soit l'identifiant de l'association, soit le SIREN, soit le SIRET.
*
* @param array $queryParameters {
*
* @var string $id_association Identifiant de l'association
* @var string $siret SIRET de l'association
* @var string $siren SIREN de l'association
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\Association|null : ResponseInterface)
*
* @throws Exception\AssociationBadRequestException
* @throws Exception\AssociationUnauthorizedException
* @throws Exception\AssociationNotFoundException
* @throws Exception\AssociationServiceUnavailableException
*/
public function association(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new Association($queryParameters), $fetch);
}
/**
* Tous les paramètres sont optionnels et servent à filtrer la recherche. Les différentes entreprises seront renvoyées dans un tableau `resultats`, et le nombre total de résultats sera renvoyé dans le champ `total`.
*
* Pour parcourir l'ensemble des résultats, deux solutions sont possibles :
*
* - La pagination (paramètres `page` et `par_page`), limitée aux 400 premiers résultats ;
* - Les curseurs (paramètres `curseur` et `par_curseur`).
*
* @param array $queryParameters {
*
* @var int $page Page de résultats. Valeur par défaut : `1`.
* @var int $par_page Nombre de résultats affichés sur une page. Valeur par défaut : `10`.
* @var string $curseur Curseur servant à parcourir l'ensemble des résultats (alternativement à la pagination qui est limitée à 400 résultats maximum). Doit valoir `*` pour la première requête, et doit pour les requêtes suivantes reprendre la valeur `curseurSuivant` retournée par la dernière réponse.
* @var int $par_curseur Nombre de résultats affichés par curseur. Valeur par défaut : `50`. Valeur minimale: `1`. Valeur maximale : `1000`.
* @var string $bases Bases de données dans lesquelles rechercher. Il est possible d'indiquer plusieurs bases en les séparant par des virgules. Valeur par défaut : `"entreprises"`.
* @var string $precision Niveau de précision de la recherche. Valeur par défaut : `"standard"`.
* @var string $q Texte à rechercher. Dénomination pour une personne morale, nom et prénom pour une personne physique.
* Si vous recherchez dans plusieurs bases, ce paramètre sera utilisé pour rechercher dans toutes les bases.
* @var string $siege Défini si la requête se base sur le siège
* @var string $code_naf Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.
* @var string $departement Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.
* @var string $region Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.
* @var string $code_postal Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.
* @var string $convention_collective convention collective de l'entreprise
* @var string $categorie_juridique Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129).
*
**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.
* @var bool $entreprise_cessee activité de l'entreprise cessée ou non
* @var string $statut_rcs Statut au RCS
* @var string $objet_social objet social de l'entreprise déclaré au RCS
* @var string $date_immatriculation_rcs_min date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_immatriculation_rcs_max d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_min date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_max date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $capital_min capital minimum de l'entreprise
* @var string $capital_max capital maximum de l'entreprise
* @var string $chiffre_affaires_min Chiffre d'affaires minimum de l'entreprise.
*
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $chiffre_affaires_max Chiffre d'affaires maximum de l'entreprise.
*
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_min Résultat minimum de l'entreprise.
*
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_max Résultat maximum de l'entreprise.
*
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $date_creation_min date de création minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_creation_max date de création maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $tranche_effectif_min Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
*
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $tranche_effectif_max Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
*
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $type_dirigeant type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $qualite_dirigeant qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nationalite_dirigeant nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nom_dirigeant nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $prenom_dirigeant prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_min âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_max âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_dirigeant_min date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_dirigeant_max date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var int $age_beneficiaire_min âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var int $age_beneficiaire_max âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_beneficiaire_min date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_beneficiaire_max date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var string $nationalite_beneficiaire nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $date_depot_document_min date de dépôt minimale du document, au format JJ-MM-AAAA
* @var string $date_depot_document_max date de dépôt maximale du document, au format JJ-MM-AAAA
* @var string $type_publication Type de publication
* @var string $date_publication_min date publication minimale de la publication, au format JJ-MM-AAAA
* @var string $date_publication_max Date de publication maximale de la publication, au format JJ-MM-AAAA.
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\RechercheGetResponse200|null : ResponseInterface)
*
* @throws Exception\RechercheUnauthorizedException
* @throws Exception\RechercheNotFoundException
* @throws Exception\RechercheServiceUnavailableException
*/
public function recherche(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new Recherche($queryParameters), $fetch);
}
/**
* Tous les paramètres sont optionnels et servent à filtrer la recherche. Les différents dirigeants seront renvoyées dans un tableau `resultats`.
*
* @param array $queryParameters {
*
* @var int $par_page Nombre de résultats affichés sur une page. Valeur par défaut : `10`.
* @var int $page Page de résultats. Valeur par défaut : `1`.
* @var string $precision Niveau de précision de la recherche. Valeur par défaut : `"standard"`.
* @var string $q Texte à rechercher. Nom et prénom du dirigeant pour une personne physique, dénomination pour une personne morale.
* @var string $type_dirigeant type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $qualite_dirigeant qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nationalite_dirigeant nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nom_dirigeant nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $prenom_dirigeant prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_min âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_max âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_dirigeant_min date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_dirigeant_max date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var string $code_naf Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.
* @var string $departement Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.
* @var string $region Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.
* @var string $code_postal Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.
* @var string $convention_collective convention collective de l'entreprise
* @var string $categorie_juridique Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129).
**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.
* @var bool $entreprise_cessee activité de l'entreprise cessée ou non
* @var string $statut_rcs Statut au RCS
* @var string $objet_social objet social de l'entreprise déclaré au RCS
* @var string $date_immatriculation_rcs_min date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_immatriculation_rcs_max d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_min date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_max date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $capital_min capital minimum de l'entreprise
* @var string $capital_max capital maximum de l'entreprise
* @var string $chiffre_affaires_min Chiffre d'affaires minimum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $chiffre_affaires_max Chiffre d'affaires maximum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_min Résultat minimum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_max Résultat maximum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $date_creation_min date de création minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_creation_max date de création maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $tranche_effectif_min Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $tranche_effectif_max Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var int $age_beneficiaire_min âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var int $age_beneficiaire_max âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_beneficiaire_min date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_beneficiaire_max date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var string $nationalite_beneficiaire nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $date_depot_document_min date de dépôt minimale du document, au format JJ-MM-AAAA
* @var string $date_depot_document_max date de dépôt maximale du document, au format JJ-MM-AAAA
* @var string $type_publication Type de publication
* @var string $date_publication_min date publication minimale de la publication, au format JJ-MM-AAAA
* @var string $date_publication_max date de publication maximale de la publication, au format JJ-MM-AAAA
* @var string $siren SIREN de l'entreprise.
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\RechercheDirigeantsGetResponse200|null : ResponseInterface)
*
* @throws Exception\RechercheDirigeantsUnauthorizedException
* @throws Exception\RechercheDirigeantsNotFoundException
* @throws Exception\RechercheDirigeantsServiceUnavailableException
*/
public function rechercheDirigeants(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new RechercheDirigeants($queryParameters), $fetch);
}
/**
* Tous les paramètres sont optionnels et servent à filtrer la recherche. Les différents bénéficiaires effectifs seront renvoyées dans un tableau `resultats`.
*
* @param array $queryParameters {
*
* @var int $par_page Nombre de résultats affichés sur une page. Valeur par défaut : `10`.
* @var int $page Page de résultats. Valeur par défaut : `1`.
* @var string $precision Niveau de précision de la recherche. Valeur par défaut : `"standard"`.
* @var string $q nom et/ou prénom du bénéficiaire effectif
* @var int $age_beneficiaire_min âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var int $age_beneficiaire_max âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_beneficiaire_min date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_beneficiaire_max date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var string $nationalite_beneficiaire nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $code_naf Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.
* @var string $departement Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.
* @var string $region Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.
* @var string $code_postal Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.
* @var string $convention_collective convention collective de l'entreprise
* @var string $categorie_juridique Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129).
**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.
* @var bool $entreprise_cessee activité de l'entreprise cessée ou non
* @var string $statut_rcs Statut au RCS
* @var string $objet_social objet social de l'entreprise déclaré au RCS
* @var string $date_immatriculation_rcs_min date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_immatriculation_rcs_max d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_min date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_max date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $capital_min capital minimum de l'entreprise
* @var string $capital_max capital maximum de l'entreprise
* @var string $chiffre_affaires_min Chiffre d'affaires minimum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $chiffre_affaires_max Chiffre d'affaires maximum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_min Résultat minimum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_max Résultat maximum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $date_creation_min date de création minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_creation_max date de création maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $tranche_effectif_min Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $tranche_effectif_max Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $type_dirigeant type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $qualite_dirigeant qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nationalite_dirigeant nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nom_dirigeant nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $prenom_dirigeant prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_min âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_max âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_dirigeant_min date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_dirigeant_max date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var string $date_depot_document_min date de dépôt minimale du document, au format JJ-MM-AAAA
* @var string $date_depot_document_max date de dépôt maximale du document, au format JJ-MM-AAAA
* @var string $type_publication Type de publication
* @var string $date_publication_min date publication minimale de la publication, au format JJ-MM-AAAA
* @var string $date_publication_max date de publication maximale de la publication, au format JJ-MM-AAAA
* @var string $siren SIREN de l'entreprise.
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\RechercheBeneficiairesGetResponse200|null : ResponseInterface)
*
* @throws Exception\RechercheBeneficiairesUnauthorizedException
* @throws Exception\RechercheBeneficiairesNotFoundException
* @throws Exception\RechercheBeneficiairesServiceUnavailableException
*/
public function rechercheBeneficiaires(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new RechercheBeneficiaires($queryParameters), $fetch);
}
/**
* Tous les paramètres sont optionnels et servent à filtrer la recherche. Les différents documents seront renvoyées dans un tableau `resultats`.
*
* @param array $queryParameters {
*
* @var int $par_page Nombre de résultats affichés sur une page. Valeur par défaut : `10`.
* @var int $page Page de résultats. Valeur par défaut : `1`.
* @var string $precision Niveau de précision de la recherche. Valeur par défaut : `"standard"`.
* @var string $q mot-clé à rechercher dans le contenu du document
* @var string $date_depot_document_min date de dépôt minimale du document, au format JJ-MM-AAAA
* @var string $date_depot_document_max date de dépôt maximale du document, au format JJ-MM-AAAA
* @var string $code_naf Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.
* @var string $departement Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.
* @var string $region Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.
* @var string $code_postal Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.
* @var string $convention_collective convention collective de l'entreprise
* @var string $categorie_juridique Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129).
**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.
* @var bool $entreprise_cessee activité de l'entreprise cessée ou non
* @var string $statut_rcs Statut au RCS
* @var string $objet_social objet social de l'entreprise déclaré au RCS
* @var string $date_immatriculation_rcs_min date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_immatriculation_rcs_max d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_min date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_max date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $capital_min capital minimum de l'entreprise
* @var string $capital_max capital maximum de l'entreprise
* @var string $chiffre_affaires_min Chiffre d'affaires minimum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $chiffre_affaires_max Chiffre d'affaires maximum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_min Résultat minimum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_max Résultat maximum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $date_creation_min date de création minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_creation_max date de création maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $tranche_effectif_min Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $tranche_effectif_max Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $type_dirigeant type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $qualite_dirigeant qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nationalite_dirigeant nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nom_dirigeant nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $prenom_dirigeant prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_min âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_max âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_dirigeant_min date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_dirigeant_max date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var int $age_beneficiaire_min âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var int $age_beneficiaire_max âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_beneficiaire_min date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_beneficiaire_max date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var string $nationalite_beneficiaire nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $type_publication Type de publication
* @var string $date_publication_min date publication minimale de la publication, au format JJ-MM-AAAA
* @var string $date_publication_max date de publication maximale de la publication, au format JJ-MM-AAAA
* @var string $siren SIREN de l'entreprise.
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\RechercheDocumentsGetResponse200|null : ResponseInterface)
*
* @throws Exception\RechercheDocumentsUnauthorizedException
* @throws Exception\RechercheDocumentsNotFoundException
* @throws Exception\RechercheDocumentsServiceUnavailableException
*/
public function rechercheDocuments(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new RechercheDocuments($queryParameters), $fetch);
}
/**
* Tous les paramètres sont optionnels et servent à filtrer la recherche. Les différentes publications seront renvoyées dans un tableau `resultats`.
*
* @param array $queryParameters {
*
* @var int $par_page Nombre de résultats affichés sur une page. Valeur par défaut : `10`.
* @var int $page Page de résultats. Valeur par défaut : `1`.
* @var string $precision Niveau de précision de la recherche. Valeur par défaut : `"standard"`.
* @var string $q mot-clé à rechercher dans le contenu de la publication
* @var string $code_naf Code NAF de l'entreprise. Il est possible d'indiquer plusieurs codes NAF en les séparant par des virgules.
* @var string $departement Numéro de département de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs départements en les séparant par des virgules.
* @var string $region Code de la région de l'un des établissements de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/4316069#titre-bloc-18). Il est possible d'indiquer plusieurs codes régions en les séparant par des virgules.
* @var string $code_postal Code postal de l'un des établissements de l'entreprise. Il est possible d'indiquer plusieurs codes postaux en les séparant par des virgules.
* @var string $convention_collective convention collective de l'entreprise
* @var string $categorie_juridique Catégorie juridique de l'entreprise, selon la [nomenclature Insee](https://www.insee.fr/fr/information/2028129).
**Note** : Le code correspond à celui de l'INSEE, à l'exception des SASU qui auront comme code 5720 et les EURL qui auront comme code 5498.
* @var bool $entreprise_cessee activité de l'entreprise cessée ou non
* @var string $statut_rcs Statut au RCS
* @var string $objet_social objet social de l'entreprise déclaré au RCS
* @var string $date_immatriculation_rcs_min date d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_immatriculation_rcs_max d'immatriculation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_min date de radiation au RCS minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_radiation_rcs_max date de radiation au RCS maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $capital_min capital minimum de l'entreprise
* @var string $capital_max capital maximum de l'entreprise
* @var string $chiffre_affaires_min Chiffre d'affaires minimum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $chiffre_affaires_max Chiffre d'affaires maximum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_min Résultat minimum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $resultat_max Résultat maximum de l'entreprise.
**Note** : Filtrer sur ce critère restreint énormément les entreprises retournées car cela élimine d'office toutes les entreprises dont les comptes ne sont pas publiés.
* @var string $date_creation_min date de création minimale de l'entreprise, au format JJ-MM-AAAA
* @var string $date_creation_max date de création maximale de l'entreprise, au format JJ-MM-AAAA
* @var string $tranche_effectif_min Tranche d'effectifs minimale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $tranche_effectif_max Tranche d'effectifs maximale de l'entreprise, selon la [nomenclature Sirene](https://www.sirene.fr/static-resources/documentation/v_sommaire_311.htm#73).
**Note** : 00 ou NN donneront les mêmes résultats et veulent dire non employeur
* @var string $type_dirigeant type du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $qualite_dirigeant qualité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nationalite_dirigeant nationalité du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $nom_dirigeant nom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $prenom_dirigeant prénom du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_min âge minimal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var int $age_dirigeant_max âge maximal du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_dirigeant_min date de naissance minimale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_dirigeant_max date de naissance maximale du dirigeant (ou de l'un des dirigeants de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var int $age_beneficiaire_min âge minimal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var int $age_beneficiaire_max âge maximal du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $date_de_naissance_beneficiaire_min date de naissance minimale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises), au format JJ-MM-AAAA
* @var string $date_de_naissance_beneficiaire_max date de naissance maximale du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises) de l'entreprise, au format JJ-MM-AAAA
* @var string $nationalite_beneficiaire nationalité du bénéficiaire effectif (ou de l'un des bénéficiaires effectifs de l'entreprise pour une recherche d'entreprises)
* @var string $date_depot_document_min date de dépôt minimale du document, au format JJ-MM-AAAA
* @var string $date_depot_document_max date de dépôt maximale du document, au format JJ-MM-AAAA
* @var string $type_publication Type de publication
* @var string $date_publication_min date publication minimale de la publication, au format JJ-MM-AAAA
* @var string $date_publication_max date de publication maximale de la publication, au format JJ-MM-AAAA
* @var string $siren SIREN de l'entreprise.
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\RecherchePublicationsGetResponse200|null : ResponseInterface)
*
* @throws Exception\RecherchePublicationsUnauthorizedException
* @throws Exception\RecherchePublicationsNotFoundException
* @throws Exception\RecherchePublicationsServiceUnavailableException
*/
public function recherchePublications(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new RecherchePublications($queryParameters), $fetch);
}
/**
* Cette route est également accessible via le point d'accès suivant : `https://suggestions.pappers.fr/v2?q=googl`.
*
* D'autre part, afin de permettre une intégration en front-end la plus directe, cette route est également accessible sans clé API, avec des limitations quotidiennes du nombre d'appels.
*
* @param array $queryParameters {
*
* @var string $q Début de recherche textuelle
* @var int $longueur Nombre de résultats. Maximum 100. Valeur par défaut : `10`.
* @var string $cibles Cibles de la recherche, séparées par des virgules. Valeur par défaut : `"nom_entreprise"`.
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\SuggestionsGetResponse200|null : ResponseInterface)
*
* @throws Exception\SuggestionsBadRequestException
*/
public function suggestions(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new Suggestions($queryParameters), $fetch);
}
/**
* Vous devez fournir le SIREN de l'entreprise pour laquelle vous souhaitez obtenir les comptes annuels.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* @var string $annee Année de cloture des comptes souhaités. Il est possible d'indiquer plusieurs années en les séparant par des virgules. Si le paramètre n'est pas fourni, toutes les années disponibles seront retournées.
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\ComptesAnnuelsBadRequestException
* @throws Exception\ComptesAnnuelsUnauthorizedException
* @throws Exception\ComptesAnnuelsNotFoundException
* @throws Exception\ComptesAnnuelsServiceUnavailableException
*/
public function comptesAnnuels(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new ComptesAnnuels($queryParameters), $fetch);
}
/**
* Cette route fournit les données nécessaires à l'établissement de la cartographie Pappers d'une entreprise telle qu'elle apparaît sur les fiches Pappers (exemple https://www.pappers.fr/entreprise/google-france-443061841#cartographie).
*
* - La requête est gratuite (erreur 404) si seul le noeud principal (l'entreprise recherchée) est disponible.
* - La requête coûte 1 crédit si, en plus du noeud principal, des noeuds dirigeants directs de l'entreprise sont disponibles. Il est possible de rejeter ces cas avec le paramètre `rejeter_premier_degre`. La requête est alors gratuite (erreur 404).
* - La requête coûte 3 crédits si des noeuds supplémentaires sont disponibles.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* @var bool $inclure_entreprises_dirigees Si vrai, la cartographie intègrera les entreprises dirigées par l'entreprise recherchée et les entreprises qui dirigent l'entreprise recherchée. Valeur par défaut : `true`.
* @var bool $inclure_entreprises_citees Si vrai, la cartographie intègrera les entreprises citées conjointement avec l'entreprise recherchée dans des actes et statuts. Valeur par défaut : `false`.
* @var bool $inclure_sci Si vrai, la cartographie intègrera les SCI. Valeur par défaut : `true`.
* @var bool $autoriser_modifications Si vrai, la cartographie pourra adapter automatiquement ses paramètres si ceux choisis manuellement ne sont pas idéaux. Valeur par défaut : `false`.
* @var bool $rejeter_premier_degre Si vrai et que la cartographie ne fait apparaître que l'entreprise recherchée ainsi que ses dirigeants directs, une erreur 404 sera renvoyée et la requête ne sera pas comptabilisée dans le quota de crédits. Valeur par défaut : `false`.
* @var int $degre Permet de choisir manuellement un degré pour la cartographie. Seuls deux états sont possibles : un nombre <= 2 ou bien un nombre > 2. Cela veut dire que 0, 1 ou 2 donneront la même cartographie, tout comme 3, 4 ou 5.
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\Cartographie|null : ResponseInterface)
*
* @throws Exception\CartographieBadRequestException
* @throws Exception\CartographieUnauthorizedException
* @throws Exception\CartographieNotFoundException
*/
public function cartographie(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new Cartographie($queryParameters), $fetch);
}
/**
* Vous devez fournir le token du document. Le document vous sera envoyé au format PDF ou XLSX.
*
* @param array $queryParameters {
*
* @var string $token Token du document
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\DocumentTelechargementBadRequestException
* @throws Exception\DocumentTelechargementUnauthorizedException
* @throws Exception\DocumentTelechargementNotFoundException
* @throws Exception\DocumentTelechargementServiceUnavailableException
*/
public function documentTelechargement(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new DocumentTelechargement($queryParameters), $fetch);
}
/**
* Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera envoyé au format PDF.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* @var string $siret SIRET de l'entreprise
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\DocumentExtraitPappersBadRequestException
* @throws Exception\DocumentExtraitPappersUnauthorizedException
* @throws Exception\DocumentExtraitPappersNotFoundException
* @throws Exception\DocumentExtraitPappersServiceUnavailableException
*/
public function documentExtraitPappers(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new DocumentExtraitPappers($queryParameters), $fetch);
}
/**
* Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera envoyé au format PDF.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* @var string $siret SIRET de l'entreprise
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\DocumentExtraitInpiBadRequestException
* @throws Exception\DocumentExtraitInpiUnauthorizedException
* @throws Exception\DocumentExtraitInpiNotFoundException
* @throws Exception\DocumentExtraitInpiServiceUnavailableException
*/
public function documentExtraitInpi(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new DocumentExtraitInpi($queryParameters), $fetch);
}
/**
* Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera envoyé au format PDF.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* @var string $siret SIRET de l'entreprise
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\DocumentAvisSituationInseeBadRequestException
* @throws Exception\DocumentAvisSituationInseeUnauthorizedException
* @throws Exception\DocumentAvisSituationInseeNotFoundException
* @throws Exception\DocumentAvisSituationInseeServiceUnavailableException
*/
public function documentAvisSituationInsee(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new DocumentAvisSituationInsee($queryParameters), $fetch);
}
/**
* Vous devez fournir soit le SIREN, soit le SIRET. Le document vous sera envoyé au format PDF.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* @var string $siret SIRET de l'entreprise
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\DocumentStatusBadRequestException
* @throws Exception\DocumentStatusUnauthorizedException
* @throws Exception\DocumentStatusNotFoundException
* @throws Exception\DocumentStatusServiceUnavailableException
*/
public function documentStatus(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new DocumentStatus($queryParameters), $fetch);
}
/**
* Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF.
*
* Seules les autorités de contrôle (<a rel='noreferrer noopener' target='_blank' href='https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000041578272/'>article R. 561-57 du Code monétaire et financier en dénombre 18</a>) et les personnes assujetties à la lutte contre le blanchiment des capitaux et le financement du terrorisme (<a rel='noreferrer noopener' target='_blank' href='https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000042648575/'>article L. 561-2 du code monétaire et financier</a>) peuvent accéder à ces informations.
*
* Pour pouvoir utiliser cette route veuillez nous contacter au préalable à api@pappers.fr
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\DocumentBeneficiairesEffectifsBadRequestException
* @throws Exception\DocumentBeneficiairesEffectifsUnauthorizedException
* @throws Exception\DocumentBeneficiairesEffectifsForbiddenException
* @throws Exception\DocumentBeneficiairesEffectifsNotFoundException
* @throws Exception\DocumentBeneficiairesEffectifsServiceUnavailableException
*/
public function documentBeneficiairesEffectifs(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new DocumentBeneficiairesEffectifs($queryParameters), $fetch);
}
/**
* Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\DocumentScoringFinancierBadRequestException
* @throws Exception\DocumentScoringFinancierUnauthorizedException
* @throws Exception\DocumentScoringFinancierNotFoundException
* @throws Exception\DocumentScoringFinancierServiceUnavailableException
*/
public function documentScoringFinancier(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new DocumentScoringFinancier($queryParameters), $fetch);
}
/**
* Vous devez fournir le SIREN. Le document vous sera envoyé au format PDF.
*
* @param array $queryParameters {
*
* @var string $siren SIREN de l'entreprise
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\DocumentScoringNonFinancierBadRequestException
* @throws Exception\DocumentScoringNonFinancierUnauthorizedException
* @throws Exception\DocumentScoringNonFinancierNotFoundException
* @throws Exception\DocumentScoringNonFinancierServiceUnavailableException
*/
public function documentScoringNonFinancier(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new DocumentScoringNonFinancier($queryParameters), $fetch);
}
/**
* Cette route vérifie le statut de personne politiquement exposée et la présence de sanctions internationales pour une personne physique.
*
* Pour vérifier le statut de dirigeants et bénéficiaires effectifs d'entreprises, vous pouvez directement utiliser la route `/entreprise` avec les champs supplémentaires `personne_politiquement_exposee` et `sanctions`.
*
* @param array $queryParameters {
*
* @var string $nom Nom de la personne physique
* @var string $prenom Prénom de la personne physique
* @var string $date_de_naissance Date de naissance de la personne physique, au format AAAA-MM-JJ ou AAAA-MM
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\ConformitePersonnePhysiqueGetResponse200|null : ResponseInterface)
*
* @throws Exception\ConformiteBadRequestException
* @throws Exception\ConformiteUnauthorizedException
* @throws Exception\ConformiteServiceUnavailableException
*/
public function conformite(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new Conformite($queryParameters), $fetch);
}
/**
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\SuiviJetonsGetResponse200|null : ResponseInterface)
*
* @throws Exception\SuiviJetonsUnauthorizedException
* @throws Exception\SuiviJetonsServiceUnavailableException
*/
public function suiviJetons(string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new SuiviJetons(), $fetch);
}
/**
* Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant de votre liste.
*
* @param Model\ListePostBodyItem[]|null $requestBody
* @param array $queryParameters {
*
* @var string $id_liste Identifiant unique de votre liste de surveillance d'entreprises
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\ListePostResponse200|Model\ListePostResponse201|null : ResponseInterface)
*
* @throws Exception\SurveillanceEntrepriseBadRequestException
* @throws Exception\SurveillanceEntrepriseUnauthorizedException
* @throws Exception\SurveillanceEntrepriseForbiddenException
* @throws Exception\SurveillanceEntrepriseNotFoundException
* @throws Exception\SurveillanceEntrepriseServiceUnavailableException
*/
public function surveillanceEntreprise(?array $requestBody = null, array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new SurveillanceEntreprise($requestBody, $queryParameters), $fetch);
}
/**
* Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant de votre liste.
*
* @param array $queryParameters {
*
* @var string $id_liste Identifiant unique de votre liste de surveillance
* @var string $siren Liste des sirens des notifications à supprimer, séparés par une virgule
* @var string $id Liste des ids des notifications à supprimer, séparés par une virgule
* @var bool $supprimer_totalite Suppression de toutes les notifications de la liste
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\ListeDeleteResponse200|null : ResponseInterface)
*
* @throws Exception\SurveillanceNotificationsDeleteBadRequestException
* @throws Exception\SurveillanceNotificationsDeleteUnauthorizedException
* @throws Exception\SurveillanceNotificationsDeleteNotFoundException
* @throws Exception\SurveillanceNotificationsDeleteServiceUnavailableException
*/
public function surveillanceNotificationsDelete(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new SurveillanceNotificationsDelete($queryParameters), $fetch);
}
/**
* Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant de votre liste. Les informations à renseigner sont différentes selon le type de personne à ajouter (morale ou physique).
*
* @param Model\ListePostBodyItem[]|null $requestBody
* @param array $queryParameters {
*
* @var string $id_liste Identifiant unique de votre liste de surveillance de dirigeants
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? Model\ListePostResponse200|Model\ListePostResponse201|null : ResponseInterface)
*
* @throws Exception\SurveillanceDirigeantBadRequestException
* @throws Exception\SurveillanceDirigeantUnauthorizedException
* @throws Exception\SurveillanceDirigeantForbiddenException
* @throws Exception\SurveillanceDirigeantNotFoundException
* @throws Exception\SurveillanceDirigeantServiceUnavailableException
*/
public function surveillanceDirigeant(?array $requestBody = null, array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new SurveillanceDirigeant($requestBody, $queryParameters), $fetch);
}
/**
* Vous devez fournir la clé d'utilisation de l'API ainsi que l'identifiant de votre liste.
*
* @param array $queryParameters {
*
* @var string $id_liste Identifiant unique de votre liste de surveillance d'entreprises
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ($fetch is 'object' ? null : ResponseInterface)
*
* @throws Exception\SurveillanceListeInformationsBadRequestException
* @throws Exception\SurveillanceListeInformationsUnauthorizedException
* @throws Exception\SurveillanceListeInformationsNotFoundException
* @throws Exception\SurveillanceListeInformationsServiceUnavailableException
*/
public function surveillanceListeInformations(?ListeInformationsPostBody $requestBody = null, array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new SurveillanceListeInformations($requestBody, $queryParameters), $fetch);
}
public static function create($httpClient = null, array $additionalPlugins = [], array $additionalNormalizers = [])
{
if (null === $httpClient) {
$httpClient = Psr18ClientDiscovery::find();
$plugins = [];
$uri = Psr17FactoryDiscovery::findUriFactory()->createUri('https://api.pappers.fr/v2');
$plugins[] = new AddHostPlugin($uri);
$plugins[] = new AddPathPlugin($uri);
if (\count($additionalPlugins) > 0) {
$plugins = array_merge($plugins, $additionalPlugins);
}
$httpClient = new PluginClient($httpClient, $plugins);
}
$requestFactory = Psr17FactoryDiscovery::findRequestFactory();
$streamFactory = Psr17FactoryDiscovery::findStreamFactory();
$normalizers = [new ArrayDenormalizer(), new JaneObjectNormalizer()];
if (\count($additionalNormalizers) > 0) {
$normalizers = array_merge($normalizers, $additionalNormalizers);
}
$serializer = new Serializer($normalizers, [new JsonEncoder(new JsonEncode(), new JsonDecode(['json_decode_associative' => true]))]);
return new static($httpClient, $requestFactory, $serializer, $streamFactory);
}
}