1. Objectif
Cet endpoint permet de filtrer une liste de dossiers clients, fournisseurs ou autres, en fonction de critères précis comme le code dossier, le SIRET, le genre, le type de genre, les numéros de téléphone, etc.
Il est utilisé pour cibler des dossiers spécifiques parmi ceux accessibles à l’utilisateur API connecté.
2. Structure de la requête
Le corps de la requête (body) est un objet JSON pouvant contenir un ou plusieurs critères de recherche.
{
"Codes": ["string"],
"Sirets": ["string"],
"Genres": ["string"],
"TypesGenre": ["string"],
"CodeCollaborateursLies": ["string"],
"NumerosTelephone": ["string"],
"DateSortie": "2025-08-07"
}| Champ | Type | Description |
|---|---|---|
Codes | tableau | Code des dossiers à filtrer |
Sirets | tableau | Numéro(s) SIRET des dossiers à filtrer. |
Genres | tableau | Code des genres à filtrer. Liste récupérable via GET /v1/genres |
TypesGenre | tableau | Type du genre : Banque, Client, Conseil, Fournisseur, OGA, SIE, SousTraitant.Liste exhaustive commune à tous les environnements. |
CodeCollaborateursLies | tableau | Code du ou des collaborateurs affectés aux dossiers. Liste récupérable via GET /V1/collaborateurs |
NumerosTelephone | tableau | Filtrage par numéro(s) de téléphone. |
DateSortie | string (date) | Exclut les dossiers sortis avant la date indiquée (format : AAAA-MM-JJ). |
💡 Remarque : Le champ TypesGenre permet de filtrer selon des catégories métiers (ex. : "Client") correspondant à plusieurs genres. Le champ Genres cible des genres spécifiques.
3. Exemples d'utilisation
Afin d’illustrer nos exemples, nous allons considérer que le endpoint GET /v1/genres renvoie les informations suivantes :
| Code Genre | Libellé | Client | Fournisseur | Conseil | SIE | Banque | OGA | Sous-traitant |
|---|---|---|---|---|---|---|---|---|
| AVOC | Avocat |
| X |
|
|
|
|
|
| BAN | Banque |
|
|
|
| X |
|
|
| CAB | Cabinet | X |
|
|
|
| X |
|
| CLI_CAC | Client CAC | X |
|
|
|
|
|
|
| CLI_IRPP | Client IRPP | X |
|
|
|
|
|
|
| CLI_ENT | Client Entreprise | X |
|
|
|
|
|
|
| CONF | Confrère |
|
|
|
|
| X |
|
| FOUR | Fournisseur |
| X |
|
|
|
|
|
| OGA | OGA |
|
|
|
|
|
| X |
| PROS | Prospect | X |
|
|
|
|
|
|
| SIE | Service des Impôts |
|
| X | X |
|
|
|
Rechercher un dossier par son code
{
"Codes": ["CLT001"]
}Recherche une liste de dossiers par leur code
{
"Codes": ["CLT001", "CLT002"]
}Rechercher les dossiers affectés au genre "Prospect"
{
"Genre": ["PROS"]
}Rechercher les dossiers de type "Client" actif (non sortis) au 07/08/2025
{
"TypesGenre": ["Client"],
"DateSortie": "2025-08-07"
}➡️ Dans cet exemple, ce filtre renverra tous les dossiers associés aux genres suivants :
CAB(Cabinet)CLI_CAC(Client CAC)CLI_IRPP(Client IRPP)CLI_ENT(Client Entreprise)PROS(Prospect)
Rechercher les dossiers actifs (non sortis) du portefeuille d'un collaborateur
Exemple pour le collaborateur ayant pour code COL001 :
{
"CodeCollaborateursLies": ["COL001"],
"DateSortie": "2025-08-07"
}