Tiers.Tiers
En bref
12 opérations sur 8 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations
| Méthode | Chemin | Rôle |
|---|---|---|
POST |
/v2/tiers/clients |
Appel POST sur tiers/clients |
GET |
/v2/tiers/clients/adresses |
Appel GET sur tiers/clients/adresses |
GET |
/v2/tiers/clients/{ctNum} |
Appel GET sur tiers/clients |
PUT |
/v2/tiers/clients/{ctNum} |
Appel PUT sur tiers/clients |
DELETE |
/v2/tiers/clients/{ctNum} |
Appel DELETE sur tiers/clients |
GET |
/v2/tiers/clients/{ctNum}/encours |
Appel GET sur tiers/clients/encours |
POST |
/v2/tiers/fournisseurs |
Appel POST sur tiers/fournisseurs |
GET |
/v2/tiers/fournisseurs/adresses |
Appel GET sur tiers/fournisseurs/adresses |
GET |
/v2/tiers/fournisseurs/{ctNum} |
Appel GET sur tiers/fournisseurs |
PUT |
/v2/tiers/fournisseurs/{ctNum} |
Appel PUT sur tiers/fournisseurs |
DELETE |
/v2/tiers/fournisseurs/{ctNum} |
Appel DELETE sur tiers/fournisseurs |
GET |
/v2/tiers/fournisseurs/{ctNum}/encours |
Appel GET sur tiers/fournisseurs/encours |
Rôle déduit
La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.
Détail
POST /v2/tiers/clients
Appel POST sur tiers/clients.
Corps de la requête (application/json)
Schéma TiersDto - 131 propriétés (détail : Schémas).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | TiersDto |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/tiers/clients" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"typeTiers": {}, "numeroTiers": "…", "numeroTiersPayeur": "…"}'
GET /v2/tiers/clients/adresses
Appel GET sur tiers/clients/adresses.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
filtre |
query | string |
non | - |
prospects |
query | boolean |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | objet |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/tiers/clients/adresses?filtre=<filtre>&prospects=<prospects>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
GET /v2/tiers/clients/{ctNum}
Appel GET sur tiers/clients.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
ctNum |
path | string |
oui | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | TiersDto |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/tiers/clients/<ctNum>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
PUT /v2/tiers/clients/{ctNum}
Appel PUT sur tiers/clients.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
ctNum |
path | string |
oui | - |
Corps de la requête (application/json)
Schéma TiersDto - 131 propriétés (détail : Schémas).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | TiersDto |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X PUT "https://<votre-connecteur>/v2/tiers/clients/<ctNum>" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"typeTiers": {}, "numeroTiers": "…", "numeroTiersPayeur": "…"}'
DELETE /v2/tiers/clients/{ctNum}
Appel DELETE sur tiers/clients.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
ctNum |
path | string |
oui | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
204 |
No Content | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
404 |
Not Found | ProblemDetails |
409 |
Conflict | ProblemDetails |
503 |
Service Unavailable | ProblemDetails |
Exemple
curl -s -X DELETE "https://<votre-connecteur>/v2/tiers/clients/<ctNum>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
GET /v2/tiers/clients/{ctNum}/encours
Appel GET sur tiers/clients/encours.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
ctNum |
path | string |
oui | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | TiersSolvabilite |
400 |
Bad Request | ProblemDetails |
401 |
Unauthorized | - |
403 |
Forbidden | - |
404 |
Not Found | ProblemDetails |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/tiers/clients/<ctNum>/encours" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/tiers/fournisseurs
Appel POST sur tiers/fournisseurs.
Corps de la requête (application/json)
Schéma TiersDto - 131 propriétés (détail : Schémas).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | TiersDto |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/tiers/fournisseurs" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"typeTiers": {}, "numeroTiers": "…", "numeroTiersPayeur": "…"}'
GET /v2/tiers/fournisseurs/adresses
Appel GET sur tiers/fournisseurs/adresses.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
filtre |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | objet |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/tiers/fournisseurs/adresses?filtre=<filtre>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
GET /v2/tiers/fournisseurs/{ctNum}
Appel GET sur tiers/fournisseurs.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
ctNum |
path | string |
oui | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | TiersDto |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/tiers/fournisseurs/<ctNum>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
PUT /v2/tiers/fournisseurs/{ctNum}
Appel PUT sur tiers/fournisseurs.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
ctNum |
path | string |
oui | - |
Corps de la requête (application/json)
Schéma TiersDto - 131 propriétés (détail : Schémas).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | TiersDto |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X PUT "https://<votre-connecteur>/v2/tiers/fournisseurs/<ctNum>" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"typeTiers": {}, "numeroTiers": "…", "numeroTiersPayeur": "…"}'
DELETE /v2/tiers/fournisseurs/{ctNum}
Appel DELETE sur tiers/fournisseurs.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
ctNum |
path | string |
oui | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
204 |
No Content | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
404 |
Not Found | ProblemDetails |
409 |
Conflict | ProblemDetails |
503 |
Service Unavailable | ProblemDetails |
Exemple
curl -s -X DELETE "https://<votre-connecteur>/v2/tiers/fournisseurs/<ctNum>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
GET /v2/tiers/fournisseurs/{ctNum}/encours
Appel GET sur tiers/fournisseurs/encours.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
ctNum |
path | string |
oui | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | TiersSolvabilite |
400 |
Bad Request | ProblemDetails |
401 |
Unauthorized | - |
403 |
Forbidden | - |
404 |
Not Found | ProblemDetails |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/tiers/fournisseurs/<ctNum>/encours" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
Schémas
Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.
ProblemDetails
ProblemDetails - 5 propriétés
| Propriété | Type | Notes |
|---|---|---|
type |
string |
nullable |
title |
string |
nullable |
status |
integer (int32) |
nullable |
detail |
string |
nullable |
instance |
string |
nullable |
TiersDto
TiersDto - 131 propriétés
| Propriété | Type | Notes |
|---|---|---|
typeTiers |
TypeTiers |
- |
numeroTiers |
string |
nullable |
numeroTiersPayeur |
string |
nullable |
idCategorieComptable |
integer (int32) |
- |
idCategorieTarifaire |
integer (int32) |
- |
idConditionLivraison |
integer (int32) |
- |
idModeExpedition |
integer (int32) |
- |
idModeleReglement |
integer (int32) |
- |
intitule |
string |
nullable |
qualite |
string |
nullable |
abrege |
string |
nullable |
contact |
string |
nullable |
compteCollectif |
string |
nullable |
adresse |
string |
nullable |
complement |
string |
nullable |
codePostal |
string |
nullable |
ville |
string |
nullable |
region |
string |
nullable |
pays |
string |
nullable |
telephone |
string |
nullable |
fax |
string |
nullable |
email |
string |
nullable |
siteWeb |
string |
nullable |
numeroSiret |
string |
nullable |
numeroTva |
string |
nullable |
codeEdi |
string |
nullable |
codeNAF |
string |
nullable |
commentaire |
string |
nullable |
langue |
LangueSage |
- |
estEnSommeil |
boolean |
- |
idDepot |
integer (int32) |
- |
numeroCentraleAchat |
string |
nullable |
idRepresentant |
integer (int32) |
- |
encoursAutorise |
number (double) |
- |
assuranceCredit |
number (double) |
- |
idRisque |
integer (int32) |
- |
idPeriodicite |
integer (int32) |
- |
factureParBonLivraison |
boolean |
- |
autorisationLivraisonPartielle |
boolean |
- |
modeControleEnCours |
ModeControleEnCours |
- |
delaiTransport |
integer (int32) |
- |
delaiApprovisionnement |
integer (int32) |
- |
prioriteLivraison |
integer (int32) |
- |
autorisationLettrageAutomatique |
boolean |
- |
nePasAppliquerPenaliteRetard |
boolean |
- |
automatiserEcritureMultiEcheances |
boolean |
- |
exclureRappelsReleve |
boolean |
- |
tauxRemise |
number (double) |
- |
tauxEscompte |
number (double) |
- |
typeCodeEDI |
TypeCodeEDI |
- |
idDevise |
integer (int32) |
- |
dateCreation |
string (date-time) |
- |
cessionCreance |
boolean |
- |
facebook |
string |
nullable |
linkedIn |
string |
nullable |
exclureTraitementMarketing |
boolean |
- |
gdprActif |
boolean |
- |
estProspect |
boolean |
- |
utilisateurCreateur |
string |
nullable |
joursCommande |
JoursCochable |
- |
joursLivraison |
JoursCochable |
- |
idCalendrier |
integer (int32) |
- |
classement |
string |
nullable |
btNum |
integer (int32) |
- |
statistique01 |
string |
nullable |
statistique02 |
string |
nullable |
statistique03 |
string |
nullable |
statistique04 |
string |
nullable |
statistique05 |
string |
nullable |
statistique06 |
string |
nullable |
statistique07 |
string |
nullable |
statistique08 |
string |
nullable |
statistique09 |
string |
nullable |
statistique10 |
string |
nullable |
tauxReleve |
number (double) |
- |
tauxRFA |
number (double) |
- |
facture |
integer (int32) |
- |
saut |
boolean |
- |
analytique |
integer (int32) |
- |
codeAffaire |
string |
nullable |
createur |
string |
nullable |
dateModification |
string (date-time) |
- |
factureElectoniqueAssujettissementTVA |
FactureElectroniqueAssujettissement |
- |
factureElectroniqueAutreIdentifiantType |
FactureElectroniqueAutreIdentifiantType |
- |
factureElectroniqueAutreIdentifiantValeur |
string |
nullable |
factureElectroniqueTypeEntite |
FactureElectroniqueTypeEntite |
- |
factureElectroniqueControleEmission |
FactureElectroniqueControleEmission |
- |
numeroBanquePrincipale |
integer (int32) |
- |
nbFacture |
integer (int32) |
- |
sautDeLignes |
boolean |
- |
raccourciClavier |
string |
nullable |
numeroCoface |
string |
nullable |
estSousSurveillance |
boolean |
- |
dateCreationSociete |
string (date-time) |
- |
formeJuridique |
string |
nullable |
effectif |
string |
nullable |
chiffreAffaires |
number (double) |
- |
resultatNet |
number (double) |
- |
privileges |
integer (int32) |
- |
incidentPaiement |
boolean |
- |
dateIncidentPaiement |
string (date-time) |
- |
regularitePaiement |
string |
nullable |
cotationSolvabilite |
string |
nullable |
dateDerniereMAJ |
string (date-time) |
- |
objetDerniereMAJ |
string |
nullable |
dateBilan |
string (date-time) |
- |
nbMoisBilan |
integer (int32) |
- |
planAnalytiqueIFRS |
integer (int32) |
- |
sectionAnalytiqueIFRS |
string |
nullable |
dateDebutFermeture |
string (date-time) |
- |
dateFinFermeture |
string (date-time) |
- |
numBanqueCourante |
integer (int32) |
- |
formatFactureElec |
integer (int32) |
- |
typeNIF |
integer (int32) |
- |
intituleRepresentantLegal |
string |
nullable |
nifRepresentantLegal |
string |
nullable |
codeEDISage |
string |
nullable |
profilSociete |
integer (int32) |
- |
statutContrat |
integer (int32) |
- |
dateMAJInformations |
string (date-time) |
- |
rapprochementFacture |
boolean |
- |
compteRenduRapprochement |
boolean |
- |
idModeleSaisieAchat |
integer (int32) |
- |
estAutoriseBAP |
boolean |
- |
codeISO2LangueEDI |
string |
nullable |
compteRenduAnnulation |
boolean |
- |
idApplicationPrefereeFactElec |
integer (int32) |
- |
dateSynchroFactElec |
string (date-time) |
- |
modeTestFactElec |
boolean |
- |
idTiersConfianceFactElec |
integer (int32) |
- |
informationsLibres |
object |
nullable |
TiersSolvabilite
TiersSolvabilite - 13 propriétés
| Propriété | Type | Notes |
|---|---|---|
baseEncours |
integer (int32) |
- |
encours |
number (double) |
- |
soldeComptable |
number (double) |
- |
solde30j |
number (double) |
- |
solde60j |
number (double) |
- |
solde90j |
number (double) |
- |
ca |
objet | nullable |
cA_HT |
objet | nullable |
reglement |
number (double) |
- |
encoursAutorise |
number (double) |
- |
assurance |
number (double) |
- |
lastFacture |
string (date-time) |
nullable |
lastReglement |
string (date-time) |
nullable |