http://api.provigis.com/api
https://api.provigis.com
Authentification
Authentification oAuth 1.0 (authentification avec popup)oAuth
Request Token
GET/requestTokenObtention d'un jeton de demande
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| oauth_consumer_key | Caractères max : 255 | Clé d'authentification cliente | a345fRtG67h8jIaWE56FHe | URL | |
| oauth_signature | Caractères max : 255 | Signature réalisé à partir du code secret | Eim1Jkkhi1t%2B622EUQI5QWKUJ3g%3D | URL | |
| oauth_signature_method | Methode de signature (uniquement HMAC-SHA1) | HMAC-SHA1 | URL | ||
| oauth_timestamp | Long | Timestamp de la requête (en millisecondes) | 1358963036476 | URL | |
| oauth_nonce | Caractères max : 255 | Chaîne de caractères aléatoire | 4572616e48616d6d65724c61686176 | URL | |
| oauth_version | Version oauth utilisé (uniquement 1.0) | 1.0 | 1.0 | URL | |
| oauth_callback | Chaine de caractères : 255 | URL appelée après l'authentification | http://www.monserveur.com/retourOauth | URL |
Réponses
Succès
{
"oauth_token":"alqmp79zjsw0ys14khp03ev4jp28ju",
"oauth_token_secret":"zml7g8k9t7gg5ipzliax1atcuv5eh8"
}Erreur
{
"error":"OAuth version must be 1.0"
}| Code HTTP | Code erreur | Message |
|---|---|---|
| 400 | 4001 | OAuth version must be 1.0 |
| 400 | 4002 | Unknown request |
| 412 | 4003 | Some parameters are missing |
| 412 | 4004 | Bad signature |
| 404 | 4106 | Consumer key or secret invalid |
| 401 | 4107 | Consumer unauthorized |
| 412 | 4008 | Invalid timestamp |
| 412 | 4009 | Too old timestamp |
| 412 | 4010 | Nonce already used |
Access Token
GET/accessTokenObtention d'un jeton d'accès
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| oauth_consumer_key | Caractères max : 255 | Clé d'authentification cliente | a345fRtG67h8jIaWE56FHe | URL | |
| oauth_signature | Caractères max : 255 | Réalisé à partir du code secret et du token secret | Eim1Jkkhi1t%2B622EUQI5QWKUJ3g%3D | URL | |
| oauth_signature_method | Methode de signature (uniquement HMAC-SHA1) | HMAC-SHA1 | URL | ||
| oauth_timestamp | Long | Timestamp de la requête (en millisecondes) | 1358963036476 | URL | |
| oauth_nonce | Caractères max : 255 | Chaîne de caractères aléatoire | 4572616e48616d6d65724c61686176 | URL | |
| oauth_token | Caractères max : 255 | Jeton de demande préalablement obtenu | 45aze2616ty616du724c616io76 | URL | |
| oauth_verifier | Caractères max : 255 | Verifier obtenu lors de la connection utilisateur | 4df616e48616d6hg6572xcvgh76 | URL | |
| oauth_version | Version oauth utilisé (uniquement 1.0) | 1.0 | 1.0 | URL |
Réponses
Succès
{
"oauth_token":"9dzwf8l7e7swz72fggoojzswfwf4z2",
"oauth_token_secret":"3na9prrujegwdkytx6nogcg0pclgp1"
}Erreur
{
"error":"OAuth version must be 1.0"
}| Code HTTP | Code erreur | Message |
|---|---|---|
| 400 | 4001 | OAuth version must be 1.0 |
| 400 | 4002 | Unknown request |
| 412 | 4003 | Some parameters are missing |
| 412 | 4005 | Unknown token |
| 412 | 4004 | Bad signature |
| 400 | 4011 | No token |
| 400 | 4012 | Invalid token |
| 400 | 4013 | Token and consumer miss match |
| 400 | 4114 | No user for token |
| 400 | 4015 | Invalid verifier |
| 400 | 4116 | Token too old, please get another token |
| 404 | 4106 | Consumer key or secret invalid |
| 401 | 4107 | Consumer unauthorized |
| 412 | 4008 | Invalid timestamp |
| 412 | 4009 | Too old timestamp |
| 412 | 4010 | Nonce already used |
Accès aux ressources
GET/*Accéder aux ressources
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| oauth_consumer_key | Caractères max : 255 | Clé d'authentification cliente | a345fRtG67h8jIaWE56FHe | URL | |
| oauth_signature | Caractères max : 255 | Réalisé à partir du code secret et du token secret | Eim1Jkkhi1t%2B622EUQI5QWKUJ3g%3D | URL | |
| oauth_signature_method | Methode de signature (uniquement HMAC-SHA1) | HMAC-SHA1 | URL | ||
| oauth_timestamp | Long | Timestamp de la requête (en millisecondes) | 1358963036476 | URL | |
| oauth_nonce | Caractères max : 255 | Chaîne de caractères aléatoire | 4572616e48616d6d65724c61686176 | URL | |
| oauth_token | Caractères max : 255 | Jeton d'accès préalablement obtenu | 45aze2616ty616du724c616io76 | URL | |
| oauth_version | Version oauth utilisé (uniquement 1.0) | 1.0 | 1.0 | URL |
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 400 | 4001 | OAuth version must be 1.0 |
| 400 | 4002 | Unknown request |
| 412 | 4003 | Some parameters are missing |
| 412 | 4005 | Unknown token |
| 412 | 4004 | Bad signature |
| 400 | 4011 | No token |
| 400 | 4012 | Invalid token |
| 400 | 4013 | Token and consumer miss match |
| 400 | 4114 | No user for token |
| 400 | 4116 | Token too old, please get another token |
| 404 | 4106 | Consumer key or secret invalid |
| 401 | 4107 | Consumer unauthorized |
| 412 | 4008 | Invalid timestamp |
| 412 | 4009 | Too old timestamp |
| 412 | 4010 | Nonce already used |
Authentification oAuth 1.0 (authentification sans popup)oAuth
Request Token
GET/requestTokenObtention d'un jeton de demande
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| oauth_consumer_key | Caractères max : 255 | Clé d'authentification cliente | a345fRtG67h8jIaWE56FHe | URL | |
| oauth_signature | Caractères max : 255 | Signature réalisé à partir du code secret | Eim1Jkkhi1t%2B622EUQI5QWKUJ3g%3D | URL | |
| oauth_signature_method | Methode de signature (uniquement HMAC-SHA1) | HMAC-SHA1 | URL | ||
| oauth_timestamp | Long | Timestamp de la requête (en millisecondes) | 1358963036476 | URL | |
| oauth_nonce | Caractères max : 255 | Chaîne de caractères aléatoire | 4572616e48616d6d65724c61686176 | URL | |
| oauth_version | Version oauth utilisé (uniquement 1.0) | 1.0 | 1.0 | URL | |
| oauth_callback | Chaine de caractères : 255 | URL appelée après l'authentification | http://www.monserveur.com/retourOauth | URL |
Réponses
Succès
{
"oauth_token":"alqmp79zjsw0ys14khp03ev4jp28ju",
"oauth_token_secret":"zml7g8k9t7gg5ipzliax1atcuv5eh8"
}Erreur
{
"error":"OAuth version must be 1.0"
}| Code HTTP | Code erreur | Message |
|---|---|---|
| 400 | 4001 | OAuth version must be 1.0 |
| 400 | 4002 | Unknown request |
| 412 | 4003 | Some parameters are missing |
| 412 | 4004 | Bad signature |
| 404 | 4106 | Consumer key or secret invalid |
| 401 | 4107 | Consumer unauthorized |
| 412 | 4008 | Invalid timestamp |
| 412 | 4009 | Too old timestamp |
| 412 | 4010 | Nonce already used |
Access Token
GET/accessTokenObtention d'un jeton d'accès
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| oauth_consumer_key | Caractères max : 255 | Clé d'authentification cliente | a345fRtG67h8jIaWE56FHe | URL | |
| oauth_signature | Caractères max : 255 | Réalisé à partir du code secret, du token secret et du mot passe Web Service | Eim1Jkkhi1t%2B622EUQI5QWKUJ3g%3D | URL | |
| oauth_signature_method | Methode de signature (uniquement HMAC-SHA1) | HMAC-SHA1 | URL | ||
| oauth_timestamp | Long | Timestamp de la requête (en millisecondes) | 1358963036476 | URL | |
| oauth_nonce | Caractères max : 255 | Chaîne de caractères aléatoire | 4572616e48616d6d65724c61686176 | URL | |
| oauth_token | Caractères max : 255 | Jeton de demande préalablement obtenu | 45aze2616ty616du724c616io76 | URL | |
| oauth_login | Utilisateur | johndoe@company.com | URL | ||
| oauth_version | Version oauth utilisé (uniquement 1.0) | 1.0 | 1.0 | URL |
Réponses
Succès
{
"oauth_token":"9dzwf8l7e7swz72fggoojzswfwf4z2",
"oauth_token_secret":"3na9prrujegwdkytx6nogcg0pclgp1"
}Erreur
{
"error":"OAuth version must be 1.0"
}| Code HTTP | Code erreur | Message |
|---|---|---|
| 400 | 4001 | OAuth version must be 1.0 |
| 400 | 4002 | Unknown request |
| 412 | 4003 | Some parameters are missing |
| 412 | 4005 | Unknown token |
| 412 | 4004 | Bad signature |
| 400 | 4011 | No token |
| 400 | 4012 | Invalid token |
| 400 | 4013 | Token and consumer miss match |
| 400 | 4114 | No user for token |
| 400 | 4015 | Invalid verifier |
| 400 | 4116 | Token too old, please get another token |
| 404 | 4106 | Consumer key or secret invalid |
| 401 | 4107 | Consumer unauthorized |
| 412 | 4008 | Invalid timestamp |
| 412 | 4009 | Too old timestamp |
| 412 | 4010 | Nonce already used |
Accès aux ressources
GET/*Accéder aux ressources
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| oauth_consumer_key | Caractères max : 255 | Clé d'authentification cliente | a345fRtG67h8jIaWE56FHe | URL | |
| oauth_signature | Caractères max : 255 | Réalisé à partir du code secret et du token secret | Eim1Jkkhi1t%2B622EUQI5QWKUJ3g%3D | URL | |
| oauth_signature_method | Methode de signature (uniquement HMAC-SHA1) | HMAC-SHA1 | URL | ||
| oauth_timestamp | Long | Timestamp de la requête (en millisecondes) | 1358963036476 | URL | |
| oauth_nonce | Caractères max : 255 | Chaîne de caractères aléatoire | 4572616e48616d6d65724c61686176 | URL | |
| oauth_token | Caractères max : 255 | Jeton d'accès préalablement obtenu | 45aze2616ty616du724c616io76 | URL | |
| oauth_version | Version oauth utilisé (uniquement 1.0) | 1.0 | 1.0 | URL |
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 400 | 4001 | OAuth version must be 1.0 |
| 400 | 4002 | Unknown request |
| 412 | 4003 | Some parameters are missing |
| 412 | 4005 | Unknown token |
| 412 | 4004 | Bad signature |
| 400 | 4011 | No token |
| 400 | 4012 | Invalid token |
| 400 | 4013 | Token and consumer miss match |
| 400 | 4114 | No user for token |
| 400 | 4116 | Token too old, please get another token |
| 404 | 4106 | Consumer key or secret invalid |
| 401 | 4107 | Consumer unauthorized |
| 412 | 4008 | Invalid timestamp |
| 412 | 4009 | Too old timestamp |
| 412 | 4010 | Nonce already used |
Acheteurs
GET/buyers/{buyer_id}/groupOrganigramme groupe/filiale
Retourne l'organigramme groupe/filiale de l'entité passé en paramètre ou de l'email utilisateur passé en paramètre.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 1384089486742271133 | URL |
Exemples
Paramètres
// URL : /buyers/1384089486742271133/group
buyer_id="1384089486742271133"
Réponse
{
"id": "1384089486742271133",
"siren": "431960251",
"nicNumber": "00046",
"intercommunityVAT" : "FR13377441122"
"name": "Provigis",
"subsidiary": [{
"id": "1384089486742271134",
"siren": "431960251",
"nicNumber": "00047",
"intercommunityVAT" : "FR13377433122"
"name": "Provigis filiale 1",
"subsidiary": null
}, {
"id": "1384089486742271135",
"siren": "431960251",
"nicNumber": "00048",
"intercommunityVAT" : "FR13377433222"
"name": "Provigis filiale 2",
"subsidiary": null
}]
}
Paramètres
// URL : /buyers/1384089486742271133/group
buyer_id="1384089486742271133"
Réponse
<root>
<entity id="1384089486742271135">
<siren>431960251</siren>
<nicNumber>00046</nicNumber>
<intercommunityVAT>FR13377441122</intercommunityVAT>
<name>Provigis</name>
<subsidiaries>
<subsidiary id="1384089486742271135">
<siren>431960251</siren>
<nicNumber>00047</nicNumber>
<intercommunityVAT>FR13377433122</intercommunityVAT>
<name>Provigis filiale 1</name>
<subsidiaries></subsidiaries>
</subsidiary>
<subsidiary id="1384089486742271135">
<siren>431960251</siren>
<nicNumber>00048</nicNumber>
<intercommunityVAT>FR13377433222</intercommunityVAT>
<name>Provigis filiale 2</name>
<subsidiaries></subsidiaries>
</subsidiary>
</subsidiaries>
</entity>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 401 | 4120 | Unauthorized SIRET or ID |
GET/buyers/{buyer_id}/groupsGroupes d'un acheteur
Retourne les groupes de l'acheteur passé en paramètre.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 1384089486742271133 | URL |
Exemples
Paramètres
// URL : /buyers/1384089486742271133/groups
buyer_id="1384089486742271133"
Réponse
[
{
"id": "12313",
"name": "Groupe 1",
suppliers: [
{
"id": "1324989441812734200",
"name": "Fournisseur 1"
},
{
"id": "1324989441812734201",
"name": "Fournisseur 2"
},
{
"id": "1324989441812734300",
"name": "Fournisseur 3"
}
],
"documents": [
{
"id": "132498944181223",
"name": "Document 1"
},
{
"id": "132498944181224",
"name": "Document 2"
},
{
"id": "132498944181225",
"name": "Document 3"
}
]
},
{
"id": "123123",
"name": "Groupe 2",
suppliers: [
{
"id": "1324989441812734201",
"name": "Fournisseur 2"
},
{
"id": "1324989441812734300",
"name": "Fournisseur 3"
}
],
"documents": [
{
"id": "132498944181223",
"name": "Document 1"
}
]
}
]Paramètres
// URL : /buyers/1384089486742271133/groups
buyer_id="1384089486742271133"
Réponse
<root>
<group id="1">
<name>Groupe 1</name>
<suppliers>
<supplier id="1324989441812734200">Fournisseur 1</supplier>
<supplier id="1324989441812734201">Fournisseur 2</supplier>
<supplier id="1324989441812734300">Fournisseur 3</supplier>
</suppliers>
<documents>
<document id="132498944181223">Document 1</document>
<document id="132498944181224">Document 2</document>
<document id="132498944181225">Document 3</document>
</documents>
</group>
<group id="2">
<name>Groupe 2</name>
<suppliers>
<supplier id="1324989441812734201">Fournisseur 2</supplier>
<supplier id="1324989441812734300">Fournisseur 3</supplier>
</suppliers>
<documents>
<document id="132498944181223">Document 1</document>
</documents>
</group>
</root>
Utilisateurs
GET/buyers/{buyer_id}/usersUtilisateurs d'un acheteur
Retourne les utilisateurs d'un acheteur ordonnés par rôle et adresse email.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID (Long) | ID d'un acheteur | 1384089486742271133 | URL |
Exemples
Paramètres
// URL : /buyers/1384089486742271133/users
buyer_id="1384089486742271133"
Réponse
[
{
"id" : "6546125164654",
"email" : "user1@yopmail.com",
"civility" : "0",
"firstname": "User1",
"lastname" : "Name1",
"function" : "Directeur(trice) ou responsable de pôle",
"phone" : "1455233331",
"cellphone" : "012236644",
"role" : "1",
"passwordWebService" : "soigjo654fqpdsoknvgsdf654jhsuo"
},
{
"id" : "8546546515165154",
"email" : "user2@yopmail.com",
"civility" : "0",
"firstname": "User2",
"lastname" : "Name2",
"function" : "Chef de service",
"phone" : "313654656",
"cellphone" : "3461164648",
"role" : "2",
"passwordWebService" : "soigjo587fqpdsoknvgsdf654jhsuo"
}
]
Paramètres
// URL : /buyers/1384089486742271133/users
buyer_id="1384089486742271133"
Réponse
<root>
<users>
<user>
<id>6546125164654</id>
<email>user1@yopmail.com</email>
<civility>0</civility>
<firstname>User1</firstname>
<lastname>Name1</lastname>
<function>Directeur(trice) ou responsable de pôle</function>
<phone>1455233331</phone>
<cellphone>012236644</cellphone>
<role>1</role>
<passwordWebService>soigjo654fqpdsoknvgsdf654jhsuo</passwordWebService>
</user>
<user>
<id>8546546515165154</id>
<email>user2@yopmail.com</email>
<civility>0</civility>
<firstname>User2</firstname>
<lastname>Name2</lastname>
<function>Chef de service</function>
<phone>313654656</phone>
<cellphone>3461164648</cellphone>
<role>2</role>
<passwordWebService>soigjo587fqpdsoknvgsdf654jhsuo</passwordWebService>
</user>
</users>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 401 | 4120 | Unauthorized SIRET or ID |
| 401 | 4131 | Unauthorized email |
POST/buyers/{buyer_id}/usersCréer un utilisateur acheteur
Création d'un compte utilisateur associé à un acheteur.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Long | ID d'un acheteur | 1 | URL | |
| E-mail compte utilisateur acheteur | johndoe@company.com | BODY | |||
| lastname | Caractères max : 255 | Nom | Doe | BODY | |
| firstname | Caractères max : 255 | Prénom | John | BODY | |
| phone | Caractères max : 20 | Téléphone | 0100000000 | BODY | |
| cellphone | Caractères max : 20 | Téléphone portable | 0600000000 | BODY | |
| civility | Caractères max : 10 | Civilité | M | M ou Mme | BODY |
| function | Caractères max : 255 | Fonction | Directeur général | BODY | |
| notification | 0/1 | Notification e-mail (procédure définition de mot de passe) | 0 | 1 | BODY |
Exemples
Paramètres
// URL : /buyers/1/users
buyer_id="1"
email="johndoe@company.com"
lastname="Doe"
firstname="John"
phone="0100000000"
cellphone="0600000000"
Réponse
{
"login": "johndoe@company.com",
"id": "4303",
"entity": {
"id": "21",
"siren": "431960251",
"nicNumber": "00047",
"intercommunityVAT": "FR13377433122",
"name": "Provigis"
},
"passwordWebService": "85f1e987893817942132415a9c6a8748bf9da3d809f5a5bf58a89d0c812d9564"
}Paramètres
// URL : /buyers/1/users
buyer_id="1"
email="johndoe@company.com"
lastname="Doe"
firstname="John"
phone="0100000000"
cellphone="0600000000"
Réponse
<root>
<login>johndoe@company.com</login>
<id>4303</id>
<entity>
<id>21</id>
<siren>431960251</siren>
<nicNumber>00047</nicNumber>
<intercommunityVAT>FR13377433122</intercommunityVAT>
<name>Provigis</name>
</entity>
<passwordWebService>85f1e987893817942132415a9c6a8748bf9da3d809f5a5bf58a89d0c812d9564</passwordWebService>
</root>Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 401 | 4120 | Unauthorized SIRET or ID |
| 412 | 4017 | Invalid parameter email |
| 412 | 4123 | Email already exist |
| 412 | 4024 | Invalid parameter lastname |
| 412 | 4025 | Invalid parameter firstname |
| 412 | 4051 | Invalid parameter phone |
| 412 | 4026 | Invalid parameter cellphone |
| 412 | 4027 | Invalid parameter civility |
| 412 | 4029 | Invalid parameter function |
| 412 | 4030 | Invalid parameter email |
DELETE/buyers/{buyer_id}/users/{user_id}Délier un utilisateur
Délier un utilisateur.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Long | ID d'un acheteur | 1 | URL | |
| user_id | Long | ID d'un utilisateur | 2556465454 | URL |
Exemples
Paramètres
// URL : /buyers/{buyer_id}/users/2556465454
buyer_id = "1"
user_id = "2556465454"
Réponse
{
}Paramètres
// URL : /buyers/{buyer_id}/users
buyer_id = "1"
user_id = "321646516"
Réponse
<root>
</root>Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 401 | 4120 | Unauthorized SIRET or ID |
| 401 | 4131 | Unauthorized email |
Fournisseurs
POST/buyers/{buyer_id}/suppliersInscription d'un fournisseur
Inscription d'un fournisseur et du référent associé à un acheteur.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 1384089486742271133 | URL | |
| supplier_siret | Siret (14 chiffres) | Siret du fournisseur | 73282932000074 | BODY | |
| supplier_name | Caractères max : 255 | Nom du fournisseur | Fournisseur | BODY | |
| supplier_contact_firstname | Caractères max : 255 | Prénom du référent | John | BODY | |
| supplier_contact_lastname | Caractères max : 255 | Nom du référent | DOE | BODY | |
| supplier_contact_email | Email du référent | johndoe@company.com | BODY | ||
| supplier_contact_civility | Caractères max : 10 | Civilité du référent (Requis si email renseigné) |
M | M ou Mme | BODY |
| supplier_contact_phone | Caractères max : 20 | Téléphone du référent | 0123456789 | BODY | |
| supplier_contact_cellphone | Caractères max : 20 | Téléphone mobile du référent | 0623456789 | BODY | |
| supplier_contact_function | Caractères max : 255 | Fonction du référent | Directeur général | BODY | |
| supplier_groups | Chaîne de caractères. ID séparé par le caractère ; | ID de groupe séparé par ; | 1;2;3 | BODY | |
| supplier_custom_code | Caractères max : 255 | Code externe du fournisseur | AZERT012QSDF | BODY |
Exemples
Paramètres
// URL : /buyers/6542268789390827123/suppliers/
buyer_id="6542268789390827123"
supplier_siret="73282932005678"
supplier_name="Fournisseur"
supplier_contact_firstname="John"
supplier_contact_lastname="Doe"
supplier_contact_email="johndoe@company.com"
supplier_contact_civility="Mr"
supplier_contact_phone="0123456789"
supplier_contact_function="Directeur général"
supplier_groups="1;3"
supplier_custom_code="AZERT015QSDF"
Réponse
{
"success":{
"code":"20",
"message":"Supplier created and attached"
},
"contact_status":{
"code":"20",
"message":"Contact properly assigned"
},
"groups_status":{
"code":"20",
"message":"Groups properly assigned"
},
"custom_code_status":{
"code":"20",
"message":"Custom code properly assigned"
},
"supplier":{
"id":"2582268789390827456",
"name": "company",
"siret": "73282932005678",
"enseigne": "emblem",
"address": "2 bis rue des marais",
"postal_code": "31000",
"city": "TOULOUSE",
"country": "FRANCE",
"intercommunityVAT": "FR13377433122"
}
}
Paramètres
// URL : /buyers/6542268789390827123/suppliers/
buyer_id="6542268789390827123"
supplier_siret="73282932005678"
Réponse
{
"success":{
"code":"21",
"message":"Supplier attached"
},
"contact_status":{
"code":"00",
"message":"No contact provided"
},
"groups_status":{
"code":"00",
"message":"No group provided"
},
"custom_code_status":{
"code":"00",
"message":"No custom code provided"
},
"supplier":{
"id":"2582268789390827456",
"name": "company",
"siret": "73282932005678",
"enseigne": "emblem",
"address": "2 bis rue des marais",
"postal_code": "31000",
"city": "TOULOUSE",
"country": "FRANCE",
"intercommunityVAT": "FR13377433122"
}
}
Paramètres
// URL : /buyers/6542268789390827123/suppliers/
buyer_id="6542268789390827123"
supplier_siret="732"
Réponse
{
"error":{
"code":"50",
"message":"Invalid supplier siret"
}
}
Paramètres
// URL : /buyers/6542268789390827123/suppliers/
buyer_id="6542268789390827123"
supplier_siret="73282932005678"
supplier_name="Fournisseur"
supplier_contact_firstname="John"
supplier_contact_lastname="Doe"
supplier_contact_email="johndoe@company.com"
supplier_contact_civility="Mr"
supplier_contact_phone="0123456789"
supplier_contact_function="Directeur général"
supplier_groups="1;3"
supplier_custom_code="AZERT015QSDF"
Réponse
<root>
<success>
<code>20</code>
<message>Supplier created and attached</message>
</success>
<contact_status>
<code>20</code>
<message>Contact properly assigned</message>
</contact_status>
<groups_status>
<code>20</code>
<message>Groups properly assigned</message>
</groups_status>
<custom_code_status>
<code>20</code>
<message>Custom code properly assigned</message>
</custom_code_status>
<supplier>
<id>2582268789390827456</id>
<name>company</name>
<siret>73282932005678</siret>
<enseigne>emblem</enseigne>
<address>2 bis rue des marais</address>
<postal_code>31000</postal_code>
<city>TOULOUSE</city>
<country>FRANCE</country>
<intercommunityVAT>FR13377433122</intercommunityVAT>
</supplier>
</root>
Paramètres
// URL : /buyers/6542268789390827123/suppliers/
buyer_id="6542268789390827123"
supplier_siret="73282932005678"
Réponse
<root>
<success>
<code>21</code>
<message>Supplier attached</message>
</success>
<contact_status>
<code>00</code>
<message>No contact provided</message>
</contact_status>
<groups_status>
<code>00</code>
<message>No group provided</message>
</groups_status>
<custom_code_status>
<code>00</code>
<message>No custom code provided</message>
</custom_code_status>
<supplier>
<id>2582268789390827456</id>
<name>company</name>
<siret>73282932005678</siret>
<enseigne>emblem</enseigne>
<address>2 bis rue des marais</address>
<postal_code>31000</postal_code>
<city>TOULOUSE</city>
<country>FRANCE</country>
<intercommunityVAT>FR13377433122</intercommunityVAT>
</supplier>
</root>
Paramètres
// URL : /buyers/6542268789390827123/suppliers/
buyer_id="6542268789390827123"
supplier_siret="732"
Réponse
<root>
<error>
<code>50</code>
<message>Invalid supplier siret</message>
</error>
</root>
Succès
| Code HTTP | Champ de retour | Code de retour | Message |
|---|---|---|---|
| 200 | success | 20 | Supplier created and attached |
| 200 | success | 21 | Supplier attached |
| 200 | success | 22 | Supplier already attached |
| 200 | contact_status | 00 | No contact provided |
| 200 | contact_status | 20 | Contact properly assigned |
| 200 | contact_status | 50 | Invalid email, no contact assigned |
| 200 | contact_status | 59 | Error on contact, no contact assigned |
| 200 | groups_status | 00 | No group provided |
| 200 | groups_status | 20 | Groups properly assigned |
| 200 | groups_status | 50 | One or more invalid group_id, no group assigned |
| 200 | groups_status | 59 | Error on groups, no group assigned |
| 200 | custom_code_status | 00 | No custom code provided |
| 200 | custom_code_status | 20 | Custom code properly assigned |
| 200 | custom_code_status | 59 | Error on custom code, no custom code assigned |
Erreur
| Code HTTP | Champ de retour | Code erreur | Message |
|---|---|---|---|
| 412 | error | 50 | Invalid supplier SIRET |
| 400 | error | 51 | Supplier SIRET not registered |
| 400 | error | 52 | Inactive supplier |
| 400 | error | 53 | SIRET checking service unavailable and no supplier name provided |
DELETE/buyers/{buyer_id}/suppliers/{supplier_id}Délier un fournisseur
Délier un fournisseur.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID (Long) | ID d'une entité | 1384089486742271133 | URL | |
| supplier_id | ID (Long) | ID d'une entité | 1324059441812734224 | URL |
Exemples
Paramètres
// URL : api/buyers/1384089486742271133/suppliers/1324059441812734224
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
Réponse
{
}Paramètres
// URL : api/buyers/1384089486742271133/suppliers/1324059441812734224
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
Réponse
<root>
</root>Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 401 | 4120 | Unauthorized SIRET or ID |
| 401 | 4131 | Unauthorized email |
POST/buyers/{buyer_id}/foreignInscription d'un fournisseur étrangers
Inscription d'un fournisseur étrangers et du référent associé à un acheteur.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 1384089486742271133 | URL | |
| supplier_name | Caractères max : 255 | Nom du fournisseur | Fournisseur | BODY | |
| supplier_vatNumber | Caractères max : 255 | Numéro de TVA Intracommunautiare | EN12345678 | BODY | |
| supplier_dunsNumber | Caractères max : 255 | Numéro D-U-N-S | 123456789 | BODY | |
| supplier_address1 | Caractères max : 255 | Ligne adresse 1 | 36 long street | BODY | |
| supplier_address2 | Caractères max : 255 | Ligne adresse 2 | 3rd floor | BODY | |
| supplier_postalCode | Caractères max : 255 | Code postal | 10055 | BODY | |
| supplier_city | Caractères max : 255 | Ville | New York City | BODY | |
| supplier_country | Caractères max : 255 | Code pays (ISO 3166-2 alpha2) | US | BODY | |
| supplier_contact_firstname | Caractères max : 255 | Prénom du référent | John | BODY | |
| supplier_contact_lastname | Caractères max : 255 | Nom du référent | DOE | BODY | |
| supplier_contact_email | Email du référent | johndoe@company.com | BODY | ||
| supplier_contact_civility | Caractères max : 10 | Civilité du référent (Requis si email renseigné) |
M | M ou Mme | BODY |
| supplier_contact_phone | Caractères max : 20 | Téléphone du référent | 0123456789 | BODY | |
| supplier_contact_cellphone | Caractères max : 20 | Téléphone mobile du référent | 0623456789 | BODY | |
| supplier_contact_function | Caractères max : 255 | Fonction du référent | Directeur général | BODY | |
| supplier_groups | Chaîne de caractères. ID séparé par le caractère ; | ID de groupe séparé par ; | 1;2;3 | BODY | |
| supplier_custom_code | Caractères max : 255 | Code externe du fournisseur | AZERT012QSDF | BODY |
Exemples
Paramètres
// URL : /buyers/6542268789390827123/foreign/
buyer_id="6542268789390827123"
supplier_name="company"
supplier_address1="2 long street"
supplier_postalCode="12345"
supplier_city="London"
supplier_country="GB"
supplier_vatNumber="EN13377433122"
supplier_name="Fournisseur"
supplier_contact_firstname="John"
supplier_contact_lastname="Doe"
supplier_contact_email="johndoe@company.com"
supplier_contact_civility="Mr"
supplier_contact_phone="0123456789"
supplier_contact_function="Directeur général"
supplier_groups="1;3"
supplier_custom_code="AZERT015QSDF"
Réponse
{
"success":{
"code":"20",
"message":"Supplier created and attached"
},
"contact_status":{
"code":"20",
"message":"Contact properly assigned"
},
"groups_status":{
"code":"20",
"message":"Groups properly assigned"
},
"custom_code_status":{
"code":"20",
"message":"Custom code properly assigned"
},
"supplier":{
"id":"2582268789390827456",
"name": "company",
"siret": "",
"enseigne": null,
"address": "2 long street",
"postal_code": "12345",
"city": "London",
"country": "Royaume-Unis",
"nationalId": "EN13377433122"
}
}
Paramètres
// URL : /buyers/6542268789390827123/foreign/
buyer_id="6542268789390827123"
supplier_name="company"
supplier_address1="2 long street"
supplier_postalCode="12345"
supplier_city="London"
supplier_country="GB"
supplier_vatNumber="EN13377433122"
Réponse
{
"success":{
"code":"21",
"message":"Supplier attached"
},
"contact_status":{
"code":"00",
"message":"No contact provided"
},
"groups_status":{
"code":"00",
"message":"No group provided"
},
"custom_code_status":{
"code":"00",
"message":"No custom code provided"
},
"supplier":{
"id":"2582268789390827456",
"name": "company",
"siret": "",
"enseigne": null,
"address": "2 long street",
"postal_code": "12345",
"city": "London",
"country": "Royaume-Unis",
"nationalId": "EN13377433122"
}
}
Paramètres
// URL : /buyers/6542268789390827123/foreign/
buyer_id="6542268789390827123"
supplier_address1="2 long street"
supplier_postalCode="12345"
supplier_city="London"
supplier_vatNumber="EN13377433122"
Réponse
{
"error":{
"code":"50",
"message":"Invalid fields : supplier_name, supplier_country"
}
}
Paramètres
// URL : /buyers/6542268789390827123/foreign/
buyer_id="6542268789390827123"
supplier_name="company"
supplier_address1="2 long street"
supplier_postalCode="12345"
supplier_city="London"
supplier_country="GB"
supplier_vatNumber="EN13377433122"
supplier_contact_firstname="John"
supplier_contact_lastname="Doe"
supplier_contact_email="johndoe@company.com"
supplier_contact_civility="Mr"
supplier_contact_phone="0123456789"
supplier_contact_function="Directeur général"
supplier_groups="1;3"
supplier_custom_code="AZERT015QSDF"
Réponse
<root>
<success>
<code>20</code>
<message>Supplier created and attached</message>
</success>
<contact_status>
<code>20</code>
<message>Contact properly assigned</message>
</contact_status>
<groups_status>
<code>20</code>
<message>Groups properly assigned</message>
</groups_status>
<custom_code_status>
<code>20</code>
<message>Custom code properly assigned</message>
</custom_code_status>
<supplier>
<id>2582268789390827456</id>
<name>company</name>
<siret></siret>
<enseigne></enseigne>
<address>2 long street</address>
<postal_code>12345</postal_code>
<city>London</city>
<country>Royaume-Unis</country>
<nationalId>EN13377433122</nationalId>
</supplier>
</root>
Paramètres
// URL : /buyers/6542268789390827123/foreign/
buyer_id="6542268789390827123"
supplier_name="company"
supplier_address1="2 long street"
supplier_postalCode="12345"
supplier_city="London"
supplier_country="GB"
supplier_vatNumber="EN13377433122"
Réponse
<root>
<success>
<code>21</code>
<message>Supplier attached</message>
</success>
<contact_status>
<code>00</code>
<message>No contact provided</message>
</contact_status>
<groups_status>
<code>00</code>
<message>No group provided</message>
</groups_status>
<custom_code_status>
<code>00</code>
<message>No custom code provided</message>
</custom_code_status>
<supplier>
<id>2582268789390827456</id>
<name>company</name>
<siret>73282932005678</siret>
<enseigne>emblem</enseigne>
<address>2 long street</address>
<postal_code>12345</postal_code>
<city>London</city>
<country>Royaume-Unis</country>
<nationalId>EN13377433122</nationalId>
</supplier>
</root>
Paramètres
// URL : /buyers/6542268789390827123/foreign/
buyer_id="6542268789390827123"
supplier_address1="2 long street"
supplier_postalCode="12345"
supplier_city="London"
supplier_vatNumber="EN13377433122"
Réponse
<root>
<error>
<code>50</code>
<message>Invalid fields : supplier_name, supplier_country</message>
</error>
</root>
Succès
| Code HTTP | Champ de retour | Code de retour | Message |
|---|---|---|---|
| 200 | success | 20 | Supplier created and attached |
| 200 | success | 21 | Supplier attached |
| 200 | success | 22 | Supplier already attached |
| 200 | contact_status | 00 | No contact provided |
| 200 | contact_status | 20 | Contact properly assigned |
| 200 | contact_status | 50 | Invalid email, no contact assigned |
| 200 | contact_status | 59 | Error on contact, no contact assigned |
| 200 | groups_status | 00 | No group provided |
| 200 | groups_status | 20 | Groups properly assigned |
| 200 | groups_status | 50 | One or more invalid group_id, no group assigned |
| 200 | groups_status | 59 | Error on groups, no group assigned |
| 200 | custom_code_status | 00 | No custom code provided |
| 200 | custom_code_status | 20 | Custom code properly assigned |
| 200 | custom_code_status | 59 | Error on custom code, no custom code assigned |
Erreur
| Code HTTP | Champ de retour | Code erreur | Message |
|---|---|---|---|
| 412 | error | 50 | Invalid fields : supplier_name |
Statuts
GET/buyers/{buyer_id}/status ObsolèteStatut des fournisseurs d'un acheteur
Obsolète : utiliser plutôt la v2 GET:/buyers/{buyer_id}/suppliers
Retourne les informations sur le statut des fournisseurs d'un acheteur donné.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 1384089486742271133 | URL | |
| level | Entier | 1, 2 ou 3 | Maximum autorisé | 1 | URL |
| offset | Entier | Index de départ | 0 | 0 | URL |
| max | Entier (50 max) | Nombre d'enregistrement | Maximum autorisé (50) | 20 | URL |
Exemples
Paramètres
// URL : /buyers/1384089486742271133/status
buyer_id="1384089486742271133"
level="1"
Réponse
{
"status": true,
"totalCount": 2,
"offset": 0,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée"
},
"1384089486742271142": {
"name": "Apside",
"status": "invalid",
"siret": " 30906508400068",
"custom_code": "XVG-962",
"address": "58 AVENUE DU GENERAL LECLERC",
"additional_address": "BP 209",
"postal_code": "92100",
"city": "BOULOGNE BILLANCOURT",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée"
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/status
buyer="1384089486742271133"
level="2"Réponse
{
"status": true,
"totalCount": 2,
"offset": 0,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"seal": { // Le champs "seal" est disponible si le fournisseur est certifié
"icon": "https://secure.provigis.com/assets/ws/certified.png",
"validity": "2016-03-30"
},
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"documents": {
"legal": [
{
"name": "kbis",
"status": "up_to_date",
"validity": "2013-01-04"
}, {
"name": "attestationUrssaf",
"status": "up_to_date",
"validity": "2013-04-04"
"type": "agessa",
"noPrecompteDocument": { // Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte
"status": "to_update",
"validity": "2016-07-10",
"validation": {
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document."
}
},
"receipt": { // Champs "receipt" disponible uniquement si type == [urssaf, ssi, msa], et peut être null
"date": "2016-01-10"
}
}, {
"name": "lnte",
"status": "to_update",
"validity": "2013-04-04",
"validation": { // Le champs "validation" est à prendre en compte uniquement si status est à "to_update"
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document." // Ce champs est à prendre en compte uniquement si status est à "invalid"
}
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"mandatory": "true"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"validity": "2013-08-04",
"mandatory": "false"
}
],
"contracts": [
{
"contractId" : "57074",
"contractReference" : "2868-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-07-11",
"dateStart": "2012-07-11",
"dateEnd": "2012-10-07",
"entitled": "1234",
"status": "up_to_date",
"validity": "2013-03-27"
}, {
"contractId" : "57073",
"contractReference" : "2868-BA2",
"buyerContact" : "Jenifer Doe",
"buyerDepartment" : "DRH",
"dateCreated": "2012-07-10",
"dateStart": "2012-07-10",
"dateEnd": "2012-08-04",
"entitled": "12345",
"status": "missing"
}, {
"contractId" : "57075",
"contractReference" : "2868-BA0",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-10-08",
"dateStart": "2012-10-08",
"dateEnd": "2013-10-31",
"entitled": "123455",
"status": "up_to_date",
"validity": "2013-04-08"
}
]
}
},
"1384089486742271142": {
"name": "Apside",
"status": "invalid",
"siret": " 30906508400068",
"custom_code": "XVG-962",
"address": "58 AVENUE DU GENERAL LECLERC",
"additional_address": "BP 209",
"postal_code": "92100",
"city": "BOULOGNE BILLANCOURT",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"documents": {
"legal": [
{
"name": "kbis",
"status": "missing"
}, {
"name": "attestationUrssaf",
"status": "missing"
}, {
"name": "lnte",
"status": "missing"
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.17",
"name": "SSII",
"docs": [
{
"name": "Document2",
"status": "missing"
}, {
"name": "Document2",
"status": "missing"
}, {
"name": "Document2",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"mandatory": "true"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"validity": "2013-08-04",
"mandatory": "false"
}
],
"contracts": [
{
"contractId" : "58000",
"contractReference" : "APS-456-BA3",
"buyerContact" : "John Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-07-02",
"dateStart": "2012-07-02",
"dateEnd": "2012-07-02",
"entitled": "456",
"status": "missing"
}
]
}
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/status
buyer="1384089486742271133"
level="3"Réponse
{
"status": true,
"totalCount": 2,
"offset": 0,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"seal": { // Le champs "seal" est disponible si le fournisseur est certifié
"icon": "https://secure.provigis.com/assets/ws/certified.png",
"validity": "2016-03-30",
"downloadLink": "api.provigis.com/download/seal/368090"
},
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"documents": {
"legal": [
{
"name": "kbis",
"status": "up_to_date",
"validity": "2013-01-04",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546aa3e91402071bac28"
}, {
"name": "attestationUrssaf",
"status": "up_to_date",
"validity": "2013-04-04",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546ba3e91402071bac2a",
"type": "agessa",
"noPrecompteDocument": { // Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte
"status": "to_update",
"validity": "2016-07-10",
"validation": {
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document."
},
"lastUpdated": "2016-01-26",
"downloadLink": "api.provigis.com/download/704804"
},
"receipt": { // Champs "receipt" disponible uniquement si type == [urssaf, ssi, msa], et peut être null
"date": "2016-01-10",
"downloadLink": "api.provigis.com/download/receipt/203032"
}
}, {
"name": "lnte",
"status": "to_update",
"validity": "2013-04-04",
"validation": { // Le champs "validation" est à prendre en compte uniquement si status est à "to_update"
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document." // Ce champs est à prendre en compte uniquement si status est à "invalid"
},
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546ba3e91402071bac2c"
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"lastUpdated": "2012-12-27",
"mandatory": "true",
"downloadLink": "https://www.provigis.com/api/download/306a546ba3e92402071bac2c"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"lastUpdated": "2012-10-04",
"mandatory": "false",
"downloadLink": "https://www.provigis.com/api/download/216a546ba3e9245a071bac21"
}
],
"contracts": [
{
"contractId" : "57074",
"contractReference" : "2868-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateStart": "2012-10-08",
"dateEnd": "2013-10-31",
"entitled": "123455",
"status": "up_to_date",
"validity": "2013-04-08",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/5072e2d34ce79c9a0f15c564"
}, {
"contractId" : "57075",
"contractReference" : "2868-BA0",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateStart": "2012-07-11",
"dateEnd": "2012-10-07",
"entitled": "1234",
"status": "up_to_date",
"validity": "2013-03-27",
"lastUpdated": "2012-10-04",
"downloadLink": "https://www.provigis.com/api/download/5064ca5257a62e4b6e1f81be"
}, {
"contractId" : "57073",
"contractReference" : "2868-BA2",
"buyerContact" : "Jenifer Doe",
"buyerDepartment" : "DRH",
"dateStart": "2012-07-10",
"dateEnd": "2012-08-04",
"entitled": "12345",
"status": "missing",
"lastUpdated": "2012-09-26"
}
]
}
},
"1384089486742271142": {
"name": "Apside",
"status": "invalid",
"siret": " 30906508400068",
"custom_code": "XVG-962",
"address": "58 AVENUE DU GENERAL LECLERC",
"additional_address": "BP 209",
"postal_code": "92100",
"city": "BOULOGNE BILLANCOURT",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"documents": {
"legal": [
{
"name": "kbis",
"status": "missing",
"lastUpdated": "2012-09-26"
}, {
"name": "attestationUrssaf",
"status": "missing",
"lastUpdated": "2012-09-26"
}, {
"name": "lnte",
"status": "missing",
"lastUpdated": "2012-09-26"
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.17",
"name": "SSII",
"docs": [
{
"name": "Document3",
"status": "missing"
}, {
"name": "Document3",
"status": "missing"
}, {
"name": "Document3",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"lastUpdated": "2012-12-27",
"mandatory": "true",
"downloadLink": "https://www.provigis.com/api/download/306a546ba3e92402071bac2c"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"lastUpdated": "2012-10-04",
"mandatory": "false",
"downloadLink": "https://www.provigis.com/api/download/216a546ba3e9245a071bac21"
}
],
"contracts": [
{
"contractId" : "58000",
"contractReference" : "APS-456-BA3",
"buyerContact" : "John Doe",
"buyerDepartment" : "DSI",
"dateStart": "2012-07-02",
"dateEnd": "2012-07-02",
"entitled": "456",
"status": "missing",
"lastUpdated": "2012-09-26"
}
]
}
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/status?level=1
buyer_id="1384089486742271133"
level="1"
Réponse
<root>
<status>true</status>
<totalCount>2</totalCount>
<offset>0</offset>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" siret="42295086500085" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée">verified</supplier>
<supplier id="1384089486742271142" name="Apside" siret="30906508400068" custom_code="XVG-962" address="58 AVENUE DU GENERAL LECLERC" additional_address="BP 209" postal_code="92100" city="BOULOGNE BILLANCOURT" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée">invalid</supplier>
</suppliers>
</root>Paramètres
// URL : /buyers/1384089486742271133/status?level=2
buyer="1384089486742271133"
level="2"
Réponse
<root>
<status>true</status>
<totalCount>2</totalCount>
<offset>0</offset>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" status="verified" siret="42295086500085" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée">
<!-- Le champs "seal" est disponible si le fournisseur est certifié -->
<seal>
<icon>https://secure.provigis.com/assets/ws/certified.png</icon>
<validity>2016-03-30</validity>
</seal>
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<documents>
<legal>
<document>
<name>kbis</name>
<status>up_to_date</status>
<validity>2013-01-04</validity>
</document>
<document>
<name>attestationUrssaf</name>
<status>up_to_date</status>
<validity>2013-04-04</validity>
<type>agessa</type>
<!-- Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte -->
<noPrecompteDocument>
<status>to_update</status>
<validity>2016-07-10</validity>
<validation>
<status>invalid</status>
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</noPrecompteDocument>
<!-- le champs "receipt" est disponible uniquement si type == [urssaf, ssi, msa], et peut être vide -->
<receipt>
<date>2016-01-10</date>
</receipt>
</document>
<document>
<name>lnte</name>
<status>up_to_date</status>
<validity>2013-04-04</validity>
<!-- Le champs "validation" est à prendre en compte uniquement si status est à "to_update" -->
<validation>
<status>invalid</status>
<!-- Le champs "message" est à prendre en compte uniquement si status est à "invalid" -->
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</document>
</legal>
<sectors>
<sector>
<codeNaf/>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<mandatory>true</mandatory>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
</document>
</specifics>
<contracts>
<contract>
<contractId>57074</contractId>
<contractReference>2868-BA3</contractReference>
<buyerContact>Jane Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>123455</entitled>
<dateCreated>2012-10-08</dateCreated>
<dateStart>2012-10-08</dateStart>
<dateEnd>2013-10-31</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-04-08</validity>
</document>
</contract>
<contract>
<contractId>57075</contractId>
<contractReference>2868-BA0</contractReference>
<buyerContact>Jane Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>1234</entitled>
<dateCreated>2012-07-11</dateCreated>
<dateStart>2012-07-11</dateStart>
<dateEnd>2012-10-07</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-03-27</validity>
</document>
</contract>
<contract>
<contractId>57073</contractId>
<contractReference>2868-BA2</contractReference>
<buyerContact>Jenifer Doe</buyerContact>
<buyerDepartment>DRH</buyerDepartment>
<entitled>12345</entitled>
<dateCreated>2012-07-10</dateCreated>
<dateStart>2012-07-10</dateStart>
<dateEnd>2012-08-04</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
<supplier id="1384089486742271142" name="Apside" status="invalid" siret="30906508400068" custom_code="XVG-962" address="58 AVENUE DU GENERAL LECLERC" additional_address="BP 209" postal_code="92100" city="BOULOGNE BILLANCOURT" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée">
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<documents>
<legal>
<document>
<name>kbis</name>
<status>missing</status>
</document>
<document>
<name>attestationUrssaf</name>
<status>missing</status>
</document>
<document>
<name>lnte</name>
<status>missing</status>
</document>
</legal>
<sectors>
<sector>
<codeNaf/>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.17<codeNaf>
<name>SSII</name>
<documents>
<document>
<name>Document2</name>
<status>missing</status>
</document>
<document>
<name>Document2</name>
<status>missing</status>
</document>
<document>
<name>Document2</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<mandatory>true</mandatory>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
</document>
</specifics>
<contracts>
<contract>
<contractId>58000</contractId>
<contractReference>APS-456-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>456</entitled>
<dateCreated>2012-07-02</dateCreated>
<dateStart>2012-07-02</dateStart>
<dateEnd>2012-07-02</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
</suppliers>
</root>Paramètres
// URL : /buyers/1384089486742271133/status?level=3
buyer="1384089486742271133"
level="3"
Réponse
<root>
<status>true</status>
<totalCount>2</totalCount>
<offset>0</offset>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" status="verified" siret="42295086500085" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée">
<!-- Le champs "seal" est disponible si le fournisseur est certifié -->
<seal>
<icon>https://secure.provigis.com/assets/ws/certified.png</icon>
<validity>2016-03-30</validity>
<downloadLink>api.provigis.com/download/seal/368090</downloadLink>
</seal>
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<documents>
<legal>
<document>
<name>kbis</name>
<status>up_to_date</status>
<validity>2013-01-04</validity>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546aa3e91402071bac28</downloadLink>
</document>
<document>
<name>attestationUrssaf</name>
<status>up_to_date</status>
<validity>2013-04-04</validity>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546ba3e91402071bac2a</downloadLink>
<type>agessa</type>
<!-- Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte -->
<noPrecompteDocument>
<status>to_update</status>
<validity>2016-07-10</validity>
<lastUpdated>2016-01-26</lastUpdated>
<downloadLink>api.provigis.com/download/704804</downloadLink>
<validation>
<status>invalid</status>
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</noPrecompteDocument>
<!-- le champs "receipt" est disponible uniquement si type == [urssaf, ssi, msa], et peut être vide -->
<receipt>
<date>2016-01-10</date>
<downloadLink>api.provigis.com/download/receipt/203032</downloadLink>
</receipt>
</document>
<document>
<name>lnte</name>
<status>up_to_date</status>
<validity>2013-04-04</validity>
<!-- Le champs "validation" est à prendre en compte uniquement si status est à "to_update" -->
<validation>
<status>invalid</status>
<!-- Le champs "message" est à prendre en compte uniquement si status est à "invalid" -->
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546ba3e91402071bac2c</downloadLink>
</document>
</legal>
<sectors>
<sector>
<codeNaf/>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<lastUpdated>2012-12-27</lastUpdated>
<mandatory>true</mandatory>
<downloadLink>https://www.provigis.com/api/download/306a546ba3e92402071bac2c</downloadLink>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
<downloadLink>https://www.provigis.com/api/download/216a546ba3e9245a071bac21</downloadLink>
</document>
</specifics>
<contracts>
<contract>
<contractId>57074</contractId>
<contractReference>2868-BA3</contractReference>
<buyerContact>Jane Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>123455</entitled>
<dateStart>2012-10-08</dateStart>
<dateEnd>2013-10-31</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-04-08</validity>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/5072e2d34ce79c9a0f15c564</downloadLink>
</document>
</contract>
<contract>
<contractId>57075</contractId>
<contractReference>2868-BA0</contractReference>
<buyerContact>Jane Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>1234</entitled>
<dateStart>2012-07-11</dateStart>
<dateEnd>2012-10-07</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<lastUpdated>2012-10-04</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/5064ca5257a62e4b6e1f81be</downloadLink>
</document>
</contract>
<contract>
<contractId>57073</contractId>
<contractReference>2868-BA2</contractReference>
<buyerContact>Jenifer Doe</buyerContact>
<buyerDepartment>DRH</buyerDepartment>
<entitled>12345</entitled>
<dateStart>2012-07-10</dateStart>
<dateEnd>2012-08-04</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
<supplier id="1384089486742271142" name="Apside" status="invalid" siret="30906508400068" custom_code="XVG-962" address="58 AVENUE DU GENERAL LECLERC" additional_address="BP 209" postal_code="92100" city="BOULOGNE BILLANCOURT" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée">
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<documents>
<legal>
<document>
<name>kbis</name>
<status>missing</status>
</document>
<document>
<name>attestationUrssaf</name>
<status>missing</status>
</document>
<document>
<name>lnte</name>
<status>missing</status>
</document>
</legal>
<sectors>
<sector>
<codeNaf>11.16<codeNaf>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.17<codeNaf>
<name>SSII</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
<document>
<name>Document1</name>
<status>missing</status>
</document>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<lastUpdated>2012-12-27</lastUpdated>
<mandatory>true</mandatory>
<downloadLink>https://www.provigis.com/api/download/306a546ba3e92402071bac2c</downloadLink>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
<downloadLink>https://www.provigis.com/api/download/216a546ba3e9245a071bac21</downloadLink>
</document>
</specifics>
<contracts>
<contract>
<contractId>58000</contractId>
<contractReference>APS-456-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>456</entitled>
<dateStart>2012-07-02</dateStart>
<dateEnd>2012-07-02</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
</suppliers>
</root>Statut des fournisseurs
| Retour | Définition |
|---|---|
| verified | Les documents légaux sont vérifiés |
| to_verify | Certains de ses documents légaux sont à vérifier |
| invalid | Certains de ses documents légaux sont invalides ou absents |
| offline | Le fournisseur est hors ligne |
Statut des documents
| Retour | Définition |
|---|---|
| up_to_date | Le document est à jour et vérifié (si vérification requise) |
| to_verify | Le document est en attente de vérification |
| to_update | Le document demande à être mis à jour, il a été invalidé ou est périmé |
| missing | Le document est absent |
Statut de validation
Le champs validation est présent dans les retours au niveau d'un document dans le cas où le document a le status "to_update".
Il est présent uniquement pour les documents vérifiables.
Ce champs contient deux champs :
- status
- message : le message d'invalidation, dans le cas où le status de la validation est à "invalid"
Le tableau ci-dessous résume les différents status de validation possibles
| Retour | Définition |
|---|---|
| valid | Le document a été vérifié et validé |
| not_verified | Le document n'a pas encore été vérifié |
| invalid | Le document a été invalidé par la vérification |
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 401 | 4120 | Unauthorized SIRET or ID |
| 412 | 4021 | Invalid parameter level |
| 412 | 4122 | Unknown level |
GET/buyers/{buyer_id}/suppliersStatut des fournisseurs d'un acheteur (v2)
Retourne les informations sur le statut des fournisseurs d'un acheteur donné (version 2)
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 1384089486742271133 | URL | |
| custom_code | Caractères max : 255 | Code fournisseur personnalisé | XVR-237 | URL | |
| level | Entier | 1, 2 ou 3 | Maximum autorisé | 1 | URL |
| offset | Entier | Index de départ | 0 | 0 | URL |
| max | Entier (50 max) | Nombre d'enregistrement | Maximum autorisé (50) | 20 | URL |
Exemples
Paramètres
// URL : /buyers/1384089486742271133/suppliers
buyer_id="1384089486742271133"
level="1"
Réponse
{
"status": true,
"totalCount": 2,
"offset": 0,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
},
"1384089486742271142": {
"name": "Apside",
"status": "invalid",
"siret": " 30906508400068",
"custom_code": "XVG-962",
"address": "58 AVENUE DU GENERAL LECLERC",
"additional_address": "BP 209",
"postal_code": "92100",
"city": "BOULOGNE BILLANCOURT",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
}
"1802268668391190677": {
"name": "Foreign",
"siret": "",
"status": "invalid",
"address": "3 long street",
"additional_address": null,
"postal_code": "675553",
"city": "London",
"intercommunityVAT": "GB1234",
"legal_form": null,
"country": "GB",
"nationalId": "GB1234",
"custom_code": ""
},
}
}
Paramètres
// URL : /buyers/1384089486742271133/suppliers
buyer_id="1384089486742271133"
level="1"
custom_code="XVG-962"
Réponse
{
"status": true,
"totalCount": 1,
"offset": 0,
"suppliers": {
"1384089486742271142": {
"name": "Apside",
"status": "invalid",
"siret": " 30906508400068",
"custom_code": "XVG-962",
"address": "58 AVENUE DU GENERAL LECLERC",
"additional_address": "BP 209",
"postal_code": "92100",
"city": "BOULOGNE BILLANCOURT",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/suppliers
buyer="1384089486742271133"
level="2"Réponse
{
"status": true,
"totalCount": 2,
"offset": 0,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
"seal": { // Le champs "seal" est disponible si le fournisseur est certifié
"icon": "https://secure.provigis.com/assets/ws/certified.png",
"validity": "2016-03-30"
},
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"notdiligent": "false",
"documents": {
"legal": [
{
"name": "kbis",
"status": "up_to_date",
"validity": "2013-01-04"
}, {
"name": "attestationUrssaf",
"status": "up_to_date",
"validity": "2013-04-04",
"type": "agessa",
"noPrecompteDocument": { // Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte
"status": "to_update",
"validity": "2016-07-10",
"validation": {
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document."
}
},
"receipt": { // Champs "receipt" disponible uniquement si type == [urssaf, ssi, msa], et peut être null
"date": "2016-01-10"
}
}, {
"name": "lnte",
"status": "to_update",
"validity": "2013-04-04",
"validation": { // Le champs "validation" est à prendre en compte uniquement si status est à "to_update"
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document." // Ce champs est à prendre en compte uniquement si status est à "invalid"
}
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"mandatory": "true"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"validity": "2013-08-04",
"mandatory": "false"
}
],
"contracts": [
{
"contractId" : "57074",
"contractReference" : "2868-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-07-11",
"dateStart": "2012-07-11",
"dateEnd": "2012-10-07",
"entitled": "1234",
"status": "up_to_date",
"validity": "2013-03-27"
}, {
"contractId" : "57073",
"contractReference" : "2868-BA2",
"buyerContact" : "Jenifer Doe",
"buyerDepartment" : "DRH",
"dateCreated": "2012-07-10",
"dateStart": "2012-07-10",
"dateEnd": "2012-08-04",
"entitled": "12345",
"status": "missing"
}, {
"contractId" : "57075",
"contractReference" : "2868-BA0",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-10-08",
"dateStart": "2012-10-08",
"dateEnd": "2013-10-31",
"entitled": "123455",
"status": "up_to_date",
"validity": "2013-04-08"
}
]
}
},
"1384089486742271142": {
"name": "Apside",
"status": "invalid",
"siret": " 30906508400068",
"custom_code": "XVG-962",
"address": "58 AVENUE DU GENERAL LECLERC",
"additional_address": "BP 209",
"postal_code": "92100",
"city": "BOULOGNE BILLANCOURT",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"notdiligent": "true",
"documents": {
"legal": [
{
"name": "kbis",
"status": "missing"
}, {
"name": "attestationUrssaf",
"status": "missing"
}, {
"name": "lnte",
"status": "missing"
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.17",
"name": "SSII",
"docs": [
{
"name": "Document2",
"status": "missing"
}, {
"name": "Document2",
"status": "missing"
}, {
"name": "Document2",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"mandatory": "true"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"validity": "2013-08-04",
"mandatory": "false"
}
],
"contracts": [
{
"contractId" : "58000",
"contractReference" : "APS-456-BA3",
"buyerContact" : "John Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-07-02",
"dateStart": "2012-07-02",
"dateEnd": "2012-07-02",
"entitled": "456",
"status": "missing"
}
]
}
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/suppliers
buyer="1384089486742271133"
level="3"Réponse
{
"status": true,
"totalCount": 2,
"offset": 0,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
"seal": { // Le champs "seal" est disponible si le fournisseur est certifié
"icon": "https://secure.provigis.com/assets/ws/certified.png",
"validity": "2016-03-30",
"downloadLink": "api.provigis.com/download/seal/368090"
},
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"notdiligent": "false",
"documents": {
"legal": [
{
"name": "kbis",
"status": "up_to_date",
"validity": "2013-01-04",
"date": "2012-07-27",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546aa3e91402071bac28"
}, {
"name": "attestationUrssaf",
"status": "up_to_date",
"validity": "2013-04-04",
"date": "2012-07-27",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546ba3e91402071bac2a",
"type": "agessa",
"noPrecompteDocument": { // Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte
"status": "to_update",
"validity": "2016-07-10",
"validation": {
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document."
},
"lastUpdated": "2016-01-26",
"downloadLink": "api.provigis.com/download/704804"
},
"receipt": { // Champs "receipt" disponible uniquement si type == [urssaf, ssi, msa], et peut être null
"date": "2016-01-10",
"downloadLink": "api.provigis.com/download/receipt/203032"
}
}, {
"name": "lnte",
"status": "up_to_date",
"validity": "2013-04-04",
"validation": { // Le champs "validation" est à prendre en compte uniquement si status est à "to_update"
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document." // Ce champs est à prendre en compte uniquement si status est à "invalid"
},
"date": "2012-07-27",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546ba3e91402071bac2c"
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"date": "2012-07-27",
"lastUpdated": "2012-12-27",
"mandatory": "true",
"downloadLink": "https://www.provigis.com/api/download/306a546ba3e92402071bac2c"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"date": "2012-07-27",
"lastUpdated": "2012-10-04",
"mandatory": "false",
"downloadLink": "https://www.provigis.com/api/download/216a546ba3e9245a071bac21"
}
],
"contracts": [
{
"contractId" : "57074",
"contractReference" : "2868-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateStart": "2012-10-08",
"dateEnd": "2013-10-31",
"entitled": "123455",
"status": "up_to_date",
"validity": "2013-04-08",
"date": "2012-07-27",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/5072e2d34ce79c9a0f15c564"
}, {
"contractId" : "57075",
"contractReference" : "2868-BA0",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateStart": "2012-07-11",
"dateEnd": "2012-10-07",
"entitled": "1234",
"status": "up_to_date",
"validity": "2013-03-27",
"date": "2012-07-27",
"lastUpdated": "2012-10-04",
"downloadLink": "https://www.provigis.com/api/download/5064ca5257a62e4b6e1f81be"
}, {
"contractId" : "57073",
"contractReference" : "2868-BA2",
"buyerContact" : "Jenifer Doe",
"buyerDepartment" : "DRH",
"dateStart": "2012-07-10",
"dateEnd": "2012-08-04",
"entitled": "12345",
"status": "missing",
"date": "2012-07-27",
"lastUpdated": "2012-09-26"
}
]
}
},
"1384089486742271142": {
"name": "Apside",
"status": "invalid",
"siret": " 30906508400068",
"custom_code": "XVG-962",
"address": "58 AVENUE DU GENERAL LECLERC",
"additional_address": "BP 209",
"postal_code": "92100",
"city": "BOULOGNE BILLANCOURT",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"notdiligent": "true",
"documents": {
"legal": [
{
"name": "kbis",
"status": "missing",
"date": "2012-07-27",
"lastUpdated": "2012-09-26"
}, {
"name": "attestationUrssaf",
"status": "missing",
"date": "2012-07-27",
"lastUpdated": "2012-09-26"
}, {
"name": "lnte",
"status": "missing",
"date": "2012-07-27",
"lastUpdated": "2012-09-26"
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.17",
"name": "SSII",
"docs": [
{
"name": "Document3",
"status": "missing"
}, {
"name": "Document3",
"status": "missing"
}, {
"name": "Document3",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"date": "2012-09-27",
"lastUpdated": "2012-12-27",
"mandatory": "true",
"downloadLink": "https://www.provigis.com/api/download/306a546ba3e92402071bac2c"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"date": "2012-07-27",
"lastUpdated": "2012-10-04",
"mandatory": "false",
"downloadLink": "https://www.provigis.com/api/download/216a546ba3e9245a071bac21"
}
],
"contracts": [
{
"contractId" : "58000",
"contractReference" : "APS-456-BA3",
"buyerContact" : "John Doe",
"buyerDepartment" : "DSI",
"dateStart": "2012-07-02",
"dateEnd": "2012-07-02",
"entitled": "456",
"status": "missing",
"date": "2012-07-27",
"lastUpdated": "2012-09-26"
}
]
}
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/suppliers?level=1
buyer_id="1384089486742271133"
level="1"
Réponse
<root>
<status>true</status>
<totalCount>2</totalCount>
<offset>0</offset>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" siret="42295086500085" status="verified" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId=""/>
<supplier id="1384089486742271142" name="Apside" siret="30906508400068" status="invalid" custom_code="XVG-962" address="58 AVENUE DU GENERAL LECLERC" additional_address="BP 209" postal_code="92100" city="BOULOGNE BILLANCOURT" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId=""/>
<supplier id="1802268668391190677" siret="" name="foreign" status="invalid" custom_code="" address="3 long street" additional_address="" postal_code="675553" city="London" intercommunityVAT="GB1234" legal_form="" country="GB" nationalId="GB1234"/>
</suppliers>
</root>Paramètres
// URL : /buyers/1384089486742271133/suppliers?level=1
buyer_id="1384089486742271133"
level="1"
custom_code="XVG-962"
Réponse
<root>
<status>true</status>
<totalCount>1</totalCount>
<offset>0</offset>
<suppliers>
<supplier id="1384089486742271142" name="Apside" siret="30906508400068" custom_code="XVG-962" address="58 AVENUE DU GENERAL LECLERC" additional_address="BP 209" postal_code="92100" city="BOULOGNE BILLANCOURT" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId="">invalid</supplier>
</suppliers>
</root>Paramètres
// URL : /buyers/1384089486742271133/suppliers?level=2
buyer="1384089486742271133"
level="2"
Réponse
<root>
<status>true</status>
<totalCount>2</totalCount>
<offset>0</offset>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" status="verified" siret="42295086500085" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId="">
<!-- Le champs "seal" est disponible si le fournisseur est certifié -->
<seal>
<icon>https://secure.provigis.com/assets/ws/certified.png</icon>
<validity>2016-03-30</validity>
</seal>
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<notdiligent>false</notdiligent>
<documents>
<legal>
<document>
<name>kbis</name>
<status>up_to_date</status>
<validity>2013-01-04</validity>
</document>
<document>
<name>attestationUrssaf</name>
<status>up_to_date</status>
<validity>2013-04-04</validity>
<type>agessa</type>
<!-- Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte -->
<noPrecompteDocument>
<status>to_update</status>
<validity>2016-07-10</validity>
<validation>
<status>invalid</status>
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</noPrecompteDocument>
<!-- le champs "receipt" est disponible uniquement si type == [urssaf, ssi, msa], et peut être vide -->
<receipt>
<date>2016-01-10</date>
</receipt>
</document>
<document>
<name>lnte</name>
<status>to_update</status>
<validity>2013-04-04</validity>
<!-- Le champs "validation" est à prendre en compte uniquement si status est à "to_update" -->
<validation>
<status>invalid</status>
<!-- Le champs "message" est à prendre en compte uniquement si status est à "invalid" -->
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</document>
</legal>
<sectors>
<sector>
<codeNaf/>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<mandatory>true</mandatory>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
</document>
</specifics>
<contracts>
<contract>
<contractId>57074</contractId>
<contractReference>2868-BA3</contractReference>
<buyerContact>Jane Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>123455</entitled>
<dateCreated>2012-10-08</dateCreated>
<dateStart>2012-10-08</dateStart>
<dateEnd>2013-10-31</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-04-08</validity>
</document>
</contract>
<contract>
<contractId>57075</contractId>
<contractReference>2868-BA0</contractReference>
<buyerContact>Jane Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>1234</entitled>
<dateCreated>2012-07-11</dateCreated>
<dateStart>2012-07-11</dateStart>
<dateEnd>2012-10-07</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-03-27</validity>
</document>
</contract>
<contract>
<contractId>57073</contractId>
<contractReference>2868-BA2</contractReference>
<buyerContact>Jenifer Doe</buyerContact>
<buyerDepartment>DRH</buyerDepartment>
<entitled>12345</entitled>
<dateCreated>2012-07-10</dateCreated>
<dateStart>2012-07-10</dateStart>
<dateEnd>2012-08-04</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
<supplier id="1384089486742271142" name="Apside" status="invalid" siret="30906508400068" custom_code="XVG-962" address="58 AVENUE DU GENERAL LECLERC" additional_address="BP 209" postal_code="92100" city="BOULOGNE BILLANCOURT" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId="">
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<notdiligent>true</notdiligent>
<documents>
<legal>
<document>
<name>kbis</name>
<status>missing</status>
</document>
<document>
<name>attestationUrssaf</name>
<status>missing</status>
</document>
<document>
<name>lnte</name>
<status>missing</status>
</document>
</legal>
<sectors>
<sector>
<codeNaf/>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.17<codeNaf>
<name>SSII</name>
<documents>
<document>
<name>Document2</name>
<status>missing</status>
</document>
<document>
<name>Document2</name>
<status>missing</status>
</document>
<document>
<name>Document2</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<mandatory>true</mandatory>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
</document>
</specifics>
<contracts>
<contract>
<contractId>58000</contractId>
<contractReference>APS-456-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>456</entitled>
<dateCreated>2012-07-02</dateCreated>
<dateStart>2012-07-02</dateStart>
<dateEnd>2012-07-02</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
</suppliers>
</root>Paramètres
// URL : /buyers/1384089486742271133/suppliers?level=3
buyer="1384089486742271133"
level="3"
Réponse
<root>
<status>true</status>
<totalCount>2</totalCount>
<offset>0</offset>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" status="verified" siret="42295086500085" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId="">
<!-- Le champs "seal" est disponible si le fournisseur est certifié -->
<seal>
<icon>https://secure.provigis.com/assets/ws/certified.png</icon>
<validity>2016-03-30</validity>
<downloadLink>api.provigis.com/download/seal/368090</downloadLink>
</seal>
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<notdiligent>false</notdiligent>
<documents>
<legal>
<document>
<name>kbis</name>
<status>up_to_date</status>
<validity>2013-01-04</validity>
<date>2012-07-27</date>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546aa3e91402071bac28</downloadLink>
</document>
<document>
<name>attestationUrssaf</name>
<status>up_to_date</status>
<validity>2013-04-04</validity>
<date>2012-07-27</date>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546ba3e91402071bac2a</downloadLink>
<type>agessa</type>
<!-- Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte -->
<noPrecompteDocument>
<status>to_update</status>
<validity>2016-07-10</validity>
<lastUpdated>2016-01-26</lastUpdated>
<downloadLink>api.provigis.com/download/704804</downloadLink>
<validation>
<status>invalid</status>
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</noPrecompteDocument>
<!-- le champs "receipt" est disponible uniquement si type == [urssaf, ssi, msa], et peut être vide -->
<receipt>
<date>2016-01-10</date>
<downloadLink>api.provigis.com/download/receipt/203032</downloadLink>
</receipt>
</document>
<document>
<name>lnte</name>
<status>to_update</status>
<validity>2013-04-04</validity>
<!-- Le champs "validation" est à prendre en compte uniquement si status est à "to_update" -->
<validation>
<status>invalid</status>
<!-- Le champs "message" est à prendre en compte uniquement si status est à "invalid" -->
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
<date>2012-07-27</date>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546ba3e91402071bac2c</downloadLink>
</document>
</legal>
<sectors>
<sector>
<codeNaf/>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<date>2012-07-27</date>
<lastUpdated>2012-12-27</lastUpdated>
<mandatory>true</mandatory>
<downloadLink>https://www.provigis.com/api/download/306a546ba3e92402071bac2c</downloadLink>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
<downloadLink>https://www.provigis.com/api/download/216a546ba3e9245a071bac21</downloadLink>
</document>
</specifics>
<contracts>
<contract>
<contractId>57074</contractId>
<contractReference>2868-BA3</contractReference>
<buyerContact>Jane Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>123455</entitled>
<dateStart>2012-10-08</dateStart>
<dateEnd>2013-10-31</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-04-08</validity>
<date>2012-07-27</date>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/5072e2d34ce79c9a0f15c564</downloadLink>
</document>
</contract>
<contract>
<contractId>57075</contractId>
<contractReference>2868-BA0</contractReference>
<buyerContact>Jane Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>1234</entitled>
<dateStart>2012-07-11</dateStart>
<dateEnd>2012-10-07</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<date>2012-07-27</date>
<lastUpdated>2012-10-04</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/5064ca5257a62e4b6e1f81be</downloadLink>
</document>
</contract>
<contract>
<contractId>57073</contractId>
<contractReference>2868-BA2</contractReference>
<buyerContact>Jenifer Doe</buyerContact>
<buyerDepartment>DRH</buyerDepartment>
<entitled>12345</entitled>
<dateStart>2012-07-10</dateStart>
<dateEnd>2012-08-04</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
<supplier id="1384089486742271142" name="Apside" status="invalid" siret="30906508400068" custom_code="XVG-962" address="58 AVENUE DU GENERAL LECLERC" additional_address="BP 209" postal_code="92100" city="BOULOGNE BILLANCOURT" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId="">
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<notdiligent>true</notdiligent>
<documents>
<legal>
<document>
<name>kbis</name>
<status>missing</status>
</document>
<document>
<name>attestationUrssaf</name>
<status>missing</status>
</document>
<document>
<name>lnte</name>
<status>missing</status>
</document>
</legal>
<sectors>
<sector>
<codeNaf>11.16<codeNaf>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.17<codeNaf>
<name>SSII</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
<document>
<name>Document1</name>
<status>missing</status>
</document>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<date>2012-07-27</date>
<lastUpdated>2012-12-27</lastUpdated>
<mandatory>true</mandatory>
<downloadLink>https://www.provigis.com/api/download/306a546ba3e92402071bac2c</downloadLink>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
<downloadLink>https://www.provigis.com/api/download/216a546ba3e9245a071bac21</downloadLink>
</document>
</specifics>
<contracts>
<contract>
<contractId>58000</contractId>
<contractReference>APS-456-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>456</entitled>
<dateStart>2012-07-02</dateStart>
<dateEnd>2012-07-02</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
</suppliers>
</root>Statut des fournisseurs
| Retour | Définition |
|---|---|
| verified | Les documents légaux sont vérifiés |
| to_verify | Certains de ses documents légaux sont à vérifier |
| invalid | Certains de ses documents légaux sont invalides ou absents |
| offline | Le fournisseur est hors ligne |
Statut des documents
| Retour | Définition |
|---|---|
| up_to_date | Le document est à jour et vérifié (si vérification requise) |
| to_verify | Le document est en attente de vérification |
| to_update | Le document demande à être mis à jour, il a été invalidé ou est périmé |
| missing | Le document est absent |
Statut de validation
Le champs validation est présent dans les retours au niveau d'un document dans le cas où le document a le status "to_update".
Il est présent uniquement pour les documents vérifiables.
Ce champs contient deux champs :
- status
- message : le message d'invalidation, dans le cas où le status de la validation est à "invalid"
Le tableau ci-dessous résume les différents status de validation possibles
| Retour | Définition |
|---|---|
| valid | Le document a été vérifié et validé |
| not_verified | Le document n'a pas encore été vérifié |
| invalid | Le document a été invalidé par la vérification |
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 401 | 4120 | Unauthorized SIRET or ID |
| 412 | 4021 | Invalid parameter level |
| 412 | 4122 | Unknown level |
GET/buyers/{buyer_id}/suppliers/{supplier_id}Statut du fournisseur d'un acheteur
Retourne les informations sur le statut du fournisseur d'un acheteur donné.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 73282932000074 | URL | |
| supplier_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 73282932000072 | URL | |
| level | Entier | 1, 2 ou 3 | Maximum autorisé | 1 | URL |
Exemples
Paramètres
// URL : /buyers/1384089486742271133/suppliers/1324059441812734224
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
level="1"
Réponse
{
"status": true,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/suppliers/1324059441812734224
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
level="2"Réponse
{
"status": true,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
"seal": { // Le champs "seal" est disponible si le fournisseur est certifié
"icon": "https://secure.provigis.com/assets/ws/certified.png",
"validity": "2016-03-30"
},
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"notdiligent": "false",
"documents": {
"legal": [
{
"name": "kbis",
"status": "up_to_date",
"validity": "2013-01-04"
}, {
"name": "attestationUrssaf",
"status": "up_to_date",
"validity": "2013-04-04",
"type": "agessa",
"noPrecompteDocument": { // Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte
"status": "to_update",
"validity": "2016-07-10",
"validation": {
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document."
}
},
"receipt": { // Champs "receipt" disponible uniquement si type == [urssaf, ssi, msa], et peut être null
"date": "2016-01-10"
}
}, {
"name": "lnte",
"status": "to_update",
"validity": "2013-04-04",
"validation": { // Le champs "validation" est à prendre en compte uniquement si status est à "to_update"
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document." // Ce champs est à prendre en compte uniquement si status est à "invalid"
}
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"mandatory": "true"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"validity": "2013-08-04",
"mandatory": "false"
}
],
"contracts": [
{
"contractId" : "57074",
"contractReference" : "2868-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-07-11",
"dateStart": "2012-07-11",
"dateEnd": "2012-10-07",
"entitled": "1234",
"status": "up_to_date",
"validity": "2013-03-27"
}, {
"contractId" : "57073",
"contractReference" : "2867-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-07-10",
"dateStart": "2012-07-10",
"dateEnd": "2012-08-04",
"entitled": "12345",
"status": "missing"
}, {
"contractId" : "57072",
"contractReference" : "2866-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-10-08",
"dateStart": "2012-10-08",
"dateEnd": "2013-10-31",
"entitled": "123455",
"status": "up_to_date",
"validity": "2013-04-08"
}
]
}
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/suppliers/1324059441812734224
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
level="3"Réponse
{
"status": true,
"suppliers": {
"1324059441812734224": {
"name": "Akka technologies",
"status": "verified",
"siret": "42295086500085",
"custom_code": "",
"address": "21 RUE ANTONIN LABORDE",
"additional_address": "BP 209",
"postal_code": "69009",
"city": "LYON",
"intercommunityVAT": "FR06318262880",
"legal_form": "Société par actions simplifiée",
"country": "FR",
"nationalId" : ""
"seal": { // Le champs "seal" est disponible si le fournisseur est certifié
"icon": "https://secure.provigis.com/assets/ws/certified.png",
"validity": "2016-03-30",
"downloadLink": "api.provigis.com/download/seal/368090"
},
"groups": [
{
"id": "1324059441812",
"name": "Électricité et chauffage"
}, {
"id": "1324059441813",
"name": "Prestations informatiques"
}
],
"notdiligent": "false",
"documents": {
"legal": [
{
"name": "kbis",
"status": "up_to_date",
"validity": "2013-01-04",
"date": "2012-07-27",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546aa3e91402071bac28"
}, {
"name": "attestationUrssaf",
"status": "up_to_date",
"validity": "2013-04-04",
"date": "2012-07-27",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546ba3e91402071bac2a",
"type": "agessa",
"noPrecompteDocument": { // Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte
"status": "to_update",
"validity": "2016-07-10",
"validation": {
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document."
},
"lastUpdated": "2016-01-26",
"downloadLink": "api.provigis.com/download/704804"
},
"receipt": { // Champs "receipt" disponible uniquement si type == [urssaf, ssi, msa], et peut être null
"date": "2016-01-10",
"downloadLink": "api.provigis.com/download/receipt/203032"
}
}, {
"name": "lnte",
"status": "to_update",
"validity": "2013-04-04",
"validation": { // Le champs "validation" est à prendre en compte uniquement si status est à "to_update"
"status": "invalid",
"message": "Il manque une ou plusieurs pages à ce document." // Ce champs est à prendre en compte uniquement si status est à "invalid"
},
"date": "2012-07-27",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/506d546ba3e91402071bac2c"
}
],
"sectors": [
{
"codeNaf": null,
"name": "Assurance(s)",
"docs": [
{
"name": "Assurance RCP",
"status": "missing"
}
]
}, {
"codeNaf": "11.16",
"name": "Prestations Informatiques et Télécoms",
"docs": [
{
"name": "Document1",
"status": "missing"
}
]
}
],
"specifics": [
{
"name": "Document spec. 1",
"status": "up_to_date",
"validity": "2013-03-27",
"date": "2012-07-27",
"lastUpdated": "2012-12-27",
"mandatory": "true",
"downloadLink": "https://www.provigis.com/api/download/306a546ba3e92402071bac2c"
}, {
"name": "Document spec. 2",
"status": "up_to_date",
"date": "2012-07-27",
"lastUpdated": "2012-10-04",
"mandatory": "false",
"downloadLink": "https://www.provigis.com/api/download/216a546ba3e9245a071bac21"
}
],
"contracts": [
{
"contractId" : "57074",
"contractReference" : "2868-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-10-08",
"dateStart": "2012-10-08",
"dateEnd": "2013-10-31",
"entitled": "123455",
"status": "up_to_date",
"validity": "2013-04-08",
"date": "2012-07-27",
"lastUpdated": "2012-10-10",
"downloadLink": "https://www.provigis.com/api/download/5072e2d34ce79c9a0f15c564"
}, {
"contractId" : "57073",
"contractReference" : "2867-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-07-11",
"dateStart": "2012-07-11",
"dateEnd": "2012-10-07",
"entitled": "1234",
"status": "up_to_date",
"validity": "2013-03-27",
"date": "2012-07-27",
"lastUpdated": "2012-10-04",
"downloadLink": "https://www.provigis.com/api/download/5064ca5257a62e4b6e1f81be"
}, {
"contractId" : "57072",
"contractReference" : "2866-BA3",
"buyerContact" : "Jane Doe",
"buyerDepartment" : "DSI",
"dateCreated": "2012-07-10",
"dateStart": "2012-07-10",
"dateEnd": "2012-08-04",
"entitled": "12345",
"status": "missing",
"date": "2012-07-27",
"lastUpdated": "2012-09-26"
}
]
}
}
}
}
Paramètres
// URL : /buyers/1384089486742271133/suppliers/1324059441812734224
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
level="1"
Réponse
<root>
<status>true</status>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" siret="42295086500085" status="verified" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId=""/>
</suppliers>
</root>Paramètres
// URL : /buyers/1384089486742271133/suppliers/1324059441812734224
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
level="2"
Réponse
<root>
<status>true</status>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" status="verified" siret="42295086500085" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId="">
<!-- Le champs "seal" est disponible si le fournisseur est certifié -->
<seal>
<icon>https://secure.provigis.com/assets/ws/certified.png</icon>
<validity>2016-03-30</validity>
</seal>
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<notdiligent>false</notdiligent>
<documents>
<legal>
<document>
<name>kbis</name>
<status>up_to_date</status>
<validity>2013-01-04</validity>
</document>
<document>
<name>attestationUrssaf</name>
<status>up_to_date</status>
<validity>2013-04-04</validity>
<type>agessa</type>
<!-- Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte -->
<noPrecompteDocument>
<status>to_update</status>
<validity>2016-07-10</validity>
<validation>
<status>invalid</status>
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</noPrecompteDocument>
<!-- le champs "receipt" est disponible uniquement si type == [urssaf, ssi, msa], et peut être vide -->
<receipt>
<date>2016-01-10</date>
</receipt>
</document>
<document>
<name>lnte</name>
<status>to_update</status>
<validity>2013-04-04</validity>
<!-- Le champs "validation" est à prendre en compte uniquement si status est à "to_update" -->
<validation>
<status>invalid</status>
<!-- Le champs "message" est à prendre en compte uniquement si status est à "invalid" -->
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</document>
</legal>
<sectors>
<sector>
<codeNaf/>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<mandatory>true</mandatory>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
</document>
</specifics>
<contracts>
<contract>
<contractId>58000</contractId>
<contractReference>APS-456-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>123455</entitled>
<dateCreated>2012-10-08</dateCreated>
<dateStart>2012-10-08</dateStart>
<dateEnd>2013-10-31</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-04-08</validity>
</document>
</contract>
<contract>
<contractId>58001</contractId>
<contractReference>APS-457-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>1234</entitled>
<dateCreated>2012-07-11</dateCreated>
<dateStart>2012-07-11</dateStart>
<dateEnd>2012-10-07</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-03-27</validity>
</document>
</contract>
<contract>
<contractId>58002</contractId>
<contractReference>APS-458-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>12345</entitled>
<dateCreated>2012-07-10</dateCreated>
<dateStart>2012-07-10</dateStart>
<dateEnd>2012-08-04</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
</suppliers>
</root>Paramètres
// URL : /buyers/1384089486742271133/suppliers/1324059441812734224
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
level="3"
Réponse
<root>
<status>true</status>
<suppliers>
<supplier id="1324059441812734224" name="Akka technologies" status="verified" siret="42295086500085" custom_code="" address="21 RUE ANTONIN LABORDE" additional_address="BP 209" postal_code="69009" city="LYON" intercommunityVAT="FR06318732880" legal_form="Société par actions simplifiée" country="FR" nationalId="">
<!-- Le champs "seal" est disponible si le fournisseur est certifié -->
<seal>
<icon>https://secure.provigis.com/assets/ws/certified.png</icon>
<validity>2016-03-30</validity>
<downloadLink>api.provigis.com/download/seal/368090</downloadLink>
</seal>
<groups>
<group id="1324059441812">Électricité et chauffage</groups>
<group id="1324059441813">Prestations informatiques</groups>
</groups>
<notdiligent>false</notdiligent>
<documents>
<legal>
<document>
<name>kbis</name>
<status>up_to_date</status>
<validity>2013-01-04</validity>
<date>2012-07-27</date>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546aa3e91402071bac28</downloadLink>
</document>
<document>
<name>attestationUrssaf</name>
<status>up_to_date</status>
<validity>2013-04-04</validity>
<date>2012-07-27</date>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546ba3e91402071bac2a</downloadLink>
<type>agessa</type>
<!-- Champs "noPrecompteDocument" disponible pour type [agessa, mda] ET que le fournisseur n'est pas soumis au régime de Précompte -->
<noPrecompteDocument>
<status>to_update</status>
<validity>2016-07-10</validity>
<lastUpdated>2016-01-26</lastUpdated>
<downloadLink>api.provigis.com/download/704804</downloadLink>
<validation>
<status>invalid</status>
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
</noPrecompteDocument>
<!-- le champs "receipt" est disponible uniquement si type == [urssaf, ssi, msa], et peut être vide -->
<receipt>
<date>2016-01-10</date>
<downloadLink>api.provigis.com/download/receipt/203032</downloadLink>
</receipt>
</document>
<document>
<name>lnte</name>
<status>to_update</status>
<validity>2013-04-04</validity>
<!-- Le champs "validation" est à prendre en compte uniquement si status est à "to_update" -->
<validation>
<status>invalid</status>
<!-- Le champs "message" est à prendre en compte uniquement si status est à "invalid" -->
<message>Il manque une ou plusieurs pages à ce document.</message>
</validation>
<date>2012-07-27</date>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/506d546ba3e91402071bac2c</downloadLink>
</document>
</legal>
<sectors>
<sector>
<codeNaf/>
<name>Assurance(s)</name>
<documents>
<document>
<name>Assurance RCP</name>
<status>missing</status>
</document>
</documents>
</sector>
<sector>
<codeNaf>11.16<codeNaf>
<name>Prestations Informatiques et Télécoms</name>
<documents>
<document>
<name>Document1</name>
<status>missing</status>
</document>
</documents>
</sector>
</sectors>
<specifics>
<document>
<name>Document spec. 1</name>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<date>2012-07-27</date>
<lastUpdated>2012-12-27</lastUpdated>
<mandatory>true</mandatory>
<downloadLink>https://www.provigis.com/api/download/306a546ba3e92402071bac2c</downloadLink>
</document>
<document>
<name>Document spec. 2</name>
<status>up_to_date</status>
<mandatory>false</mandatory>
<downloadLink>https://www.provigis.com/api/download/216a546ba3e9245a071bac21</downloadLink>
</document>
</specifics>
<contracts>
<contract>
<contractId>58000</contractId>
<contractReference>APS-456-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>123455</entitled>
<dateCreated>2012-10-08</dateCreated>
<dateStart>2012-10-08</dateStart>
<dateEnd>2013-10-31</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-04-08</validity>
<date>2012-07-27</date>
<lastUpdated>2012-10-10</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/5072e2d34ce79c9a0f15c564</downloadLink>
</document>
</contract>
<contract>
<contractId>58001</contractId>
<contractReference>APS-457-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>1234</entitled>
<dateCreated>2012-07-11</dateCreated>
<dateStart>2012-07-11</dateStart>
<dateEnd>2012-10-07</dateEnd>
<document>
<status>up_to_date</status>
<validity>2013-03-27</validity>
<date>2012-07-27</date>
<lastUpdated>2012-10-04</lastUpdated>
<downloadLink>https://www.provigis.com/api/download/5064ca5257a62e4b6e1f81be</downloadLink>
</document>
</contract>
<contract>
<contractId>58002</contractId>
<contractReference>APS-458-BA3</contractReference>
<buyerContact>John Doe</buyerContact>
<buyerDepartment>DSI</buyerDepartment>
<entitled>12345</entitled>
<dateCreated>2012-07-10</dateCreated>
<dateStart>2012-07-10</dateStart>
<dateEnd>2012-08-04</dateEnd>
<document>
<status>missing</status>
</document>
</contract>
</contracts>
</documents>
</supplier>
</suppliers>
</root>Statut des fournisseurs
| Retour | Définition |
|---|---|
| verified | Les documents légaux sont vérifiés |
| to_verify | Certains de ses documents légaux sont à vérifier |
| invalid | Certains de ses documents légaux sont invalides ou absents |
| offline | Le fournisseur est hors ligne |
Statut des documents
| Retour | Définition |
|---|---|
| up_to_date | Le document est à jour et vérifié (si vérification requise) |
| to_verify | Le document est en attente de vérification |
| to_update | Le document demande à être mis à jour, il a été invalidé ou est périmé |
| missing | Le document est absent |
Statut de validation
Le champs validation est présent dans les retours au niveau d'un document dans le cas où le document a le status "to_update".
Il est présent uniquement pour les documents vérifiables.
Ce champs contient deux champs :
- status
- message : le message d'invalidation, dans le cas où le status de la validation est à "invalid"
Le tableau ci-dessous résume les différents status de validation possibles
| Retour | Définition |
|---|---|
| valid | Le document a été vérifié et validé |
| not_verified | Le document n'a pas encore été vérifié |
| invalid | Le document a été invalidé par la vérification |
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 401 | 4120 | Unauthorized SIRET or ID |
| 412 | 4021 | Invalid parameter level |
| 412 | 4122 | Unknown level |
GET/download/{id}Téléchargement document
Retourne le document dont l'ID passé en paramètre fait référence.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| id | Caractères max : 255 | ID du document | 5064ca5257a62e4b6e1f81be | URL |
Paramètres
// URL : /download/5064ca5257a62e4b6e1f81be
id="5064ca5257a62e4b6e1f81be"
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 401 | XXXX | You cannot download this file |
| 412 | 4200 | Invalid parameter ID |
Contrats
PUT/buyers/{buyer_id}/suppliers/{supplier_id}/contracts{contract_id}Modifie un contrat passé entre un fournisseur et un acheteur
Modifie un contrat passé entre un fournisseur et un acheteur
Notice d'implémentation
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID d'un acheteur | 1384089486742271133 | URL | ||
| supplier_id | ID d'un fournisseur | 1324059441812734224 | URL | ||
| contract_id | ID d'un contrat | 57079 | URL | ||
| number | Caractères max : 255 | Numéro du contrat à créer | 12546-bd | BODY | |
| entitled | Caractères max : 255 | Titre du contrat | Migration du parc informatique vers Debian | BODY | |
| caller | Nom du contact chez l'acheteur | John Doe | BODY | ||
| entity | Département concerné chez l'acheteur | DSI | BODY | ||
| dateStart | Date | Date de début du contrat | 2012-12-31 | BODY | |
| dateEnd | Date : doit être supérieur à la date de début | Date de fin du contrat | 2013-12-31 | BODY | |
| allowBranchView | 1/0 | Visibilité du contrat pour les filiales | 0 | 0 | BODY |
Exemples
Paramètres
//URL : /buyers/1384089486742271133/suppliers/1324059441812734224/contracts
buyer_id="1384089486742271133"
supplier_id = "1324059441812734224"
number = "12546-bd"
entitled = "Migration du parc informatique vers Debian"
caller = "John Doe"
entity = "DSI"
dateStart = "2012-12-31"
dateEnd = "2013-12-31"
allowBranchView = "0"
Réponse
{
"id": "57079"
}
Paramètres
//URL : /buyers/1384089486742271133/suppliers/1324059441812734224/contracts
buyer_id="1384089486742271133"
supplier_id = "1324059441812734224"
number = "12546-bd"
entitled = "Migration du parc informatique vers Debian"
caller = "John Doe"
entity = "DSI"
dateStart = "2012-12-31"
dateEnd = "2013-12-31"
allowBranchView = "0"
Réponse
<root>
<id>57079</id>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4131 | Unauthorized email |
| 412 | 4120 | Unauthorized SIRET or ID |
| 412 | 4203 | A parameter is missing |
| 412 | 4204 | A parameter is incorrect |
| 412 | 4205 | The starting date must precede the ending date |
POST/buyers/{buyer_id}/suppliers/{supplier_id}/contractsAjout d'un contrat entre un fournisseur et un acheteur
Création d'un contrat entre un acheteur et un fournisseur.
Notice d'implémentation
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID d'un acheteur | 1384089486742271133 | URL | ||
| supplier_id | ID d'un fournisseur | 1324059441812734224 | URL | ||
| number | Caractères max : 255 | Numéro du contrat à créer | 12546-bd | BODY | |
| entitled | Caractères max : 255 | Titre du contrat | Migration du parc informatique vers Debian | BODY | |
| caller | Nom du contact chez l'acheteur | John Doe | BODY | ||
| entity | Département concerné chez l'acheteur | DSI | BODY | ||
| dateStart | Date | Date de début du contrat | 2012-12-31 | BODY | |
| dateEnd | Date : doit être supérieur à la date de début | Date de fin du contrat | 2013-12-31 | BODY | |
| allowBranchView | 1/0 | Autoriser les filiales à voir le contrat | 0 | 0 | BODY |
Exemples
Paramètres
//URL : /buyers/1384089486742271133/suppliers/1324059441812734224/contracts
buyer_id="1384089486742271133"
supplier_id = "1324059441812734224"
number = "12546-bd"
entitled = "Migration du parc informatique vers Debian"
caller = "John Doe"
entity = "DSI"
dateStart = "2012-12-31"
dateEnd = "2013-12-31"
allowBranchView = "0"
Réponse
{
"id": "57079"
}
Paramètres
//URL : /buyers/1384089486742271133/suppliers/1324059441812734224/contracts
buyer_id="1384089486742271133"
supplier_id = "1324059441812734224"
number = "12546-bd"
entitled = "Migration du parc informatique vers Debian"
caller = "John Doe"
entity = "DSI"
dateStart = "2012-12-31"
dateEnd = "2013-12-31"
allowBranchView = "0"
Réponse
<root>
<id>57079</id>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4131 | Unauthorized email |
| 412 | 4120 | Unauthorized SIRET or ID |
| 412 | 4203 | A parameter is missing |
| 412 | 4204 | A parameter is incorrect |
| 412 | 4205 | The starting date must precede the ending date |
DELETE/buyers/{buyer_id}/suppliers/{supplier_id}/contracts{contract_id}Supprime un contrat entre un acheteur et un fournisseur
Supprime un contrat entre un acheteur et un fournisseur
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID (Long) | ID de l'acheteur | 1384089486742271133 | URL | |
| supplier_id | ID (Long) | ID du fournisseur | 1324059441812734224 | URL | |
| contract_id | ID (Long) | ID du contrat | 57076 | URL |
Exemples
Paramètres
// URL : api/buyers/1384089486742271133/suppliers/1324059441812734224/contracts/57076
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
contract_id="57076"
Réponse
{
}Paramètres
// URL : api/buyers/1384089486742271133/suppliers/1324059441812734224/contracts/57076
buyer_id="1384089486742271133"
supplier_id="1324059441812734224"
contract_id="57076"
Réponse
<root>
</root>Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 400 | 4208 | The system encountered an error while processing the request |
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4131 | Unauthorized email |
| 412 | 4120 | Unauthorized SIRET or ID |
| 412 | 4203 | A parameter is missing |
| 412 | 4204 | A parameter is incorrect |
| 412 | 4205 | The starting date must precede the ending date |
Référents
GET/buyers/{buyer_id}/suppliers/{supplier_id}/referentsRéférents d'un fournisseur
Liste les référents d'un fournisseur.
Notice d'implémentation
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID d'un acheteur | 1384089486742271133 | URL | ||
| supplier_id | ID d'un fournisseur | 1324059441812734224 | URL |
Exemples
Paramètres
//URL : /buyers/1384089486742271133/suppliers/1324059441812734224/referents/
buyer_id="1384089486742271133"
supplier_id = "1324059441812734224"
Réponse
{
"supplier": {
"id": "1324059441812734224",
"siret": "40846824300023",
"name": "My Enterprise"
},
"referrers": [
{
"email": "jean.dupond@yopmail.com",
"civility": 0,
"firstname": "Jean",
"lastname": "Dupond",
"function": null,
"phone": "0923456781",
"cellphone": "0612121212"
},
{
"email": "jeanne.levant@yopmail.com",
"civility": 1,
"firstname": "Jeanne",
"lastname": "Levant",
"function": "Assistante commerciale",
"phone": " 0123456789",
"cellphone": null
}
]
}
Paramètres
//URL : /buyers/1384089486742271133/suppliers/1324059441812734224/referents/
buyer_id="1384089486742271133"
supplier_id = "1324059441812734224"
Réponse
<root>
<supplier>
<id>1324059441812734224</id>
<siret>40846824300023</siret>
<name>My Enterprise</name>
</supplier>
<referrers>
<referrer>
<email>jean.dupond@yopmail.com</email>
<civility>0</civility>
<firstname>Jean</firstname>
<lastname>Dupond</lastname>
<function/>
<phone>0923456781</phone>
<cellphone>0612121212</cellphone>
</referrer>
<referrer>
<email>jeanne.levant@yopmail.com</email>
<civility>1</civility>
<firstname>Jeanne</firstname>
<lastname>Levant</lastname>
<function>Assistante commerciale</function>
<phone>0123456789</phone>
<cellphone/>
</referrer>
</referrers>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
POST/buyers/{buyer_id}/suppliers/{supplier_id}/referentsAjout d'un référent à un fournisseur
Ajout d'un référent à un fournisseur.
Notice d'implémentation
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID d'un acheteur | 1384089486742271133 | URL | ||
| supplier_id | ID d'un fournisseur | 1324059441812734224 | URL | ||
| Caractères max : 255 | email de l'utilisateur à ajouter | test@yopmail.com | BODY | ||
| civility | 0 (Mr), 1 (Mme), 2 (Mlle) | Civilité de l'utilisateur | 0 | 0 | BODY |
| firstname | Prénom du référent | John | BODY | ||
| lastname | Nom du référent | Doe | BODY | ||
| phone | Numéro de téléphone | Numéro de téléphone du référent | 0102030405 | BODY | |
| cellphone | Numéro de téléphone mobile | Numéro de téléphone mobile du référent | 0602030405 | BODY |
Exemples
Paramètres
//URL : /buyers/1384089486742271133/suppliers/1324059441812734224/referents/
buyer="1384089486742271133"
supplier = "1324059441812734224"
email = "test@yopmail.com"
civility = "0"
firstname = "John"
lastname = " Doe"
phone = "0102030405"
cellphone = "0678912345"
Réponse
{
"id": "57079"
}
Paramètres
//URL : /buyers/1384089486742271133/suppliers/1324059441812734224/referents/
buyer="1384089486742271133"
supplier = "1324059441812734224"
email = "test@yopmail.com"
civility = "0"
firstname = "John"
lastname = " Doe"
phone = "0102030405"
cellphone = "0678912345"
Réponse
<root>
<id>57079</id>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4131 | Unauthorized email |
| 412 | 4120 | Unauthorized SIRET or ID |
| 412 | 4203 | A parameter is missing |
| 412 | 4204 | A parameter is incorrect |
Groupes
POST/groups/{group_id}/suppliersAjout d'un fournisseur au groupe
Ajoute le fournisseur passé en paramètre au groupe passé en paramètre.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| group_id | ID (Long) | ID d'un groupe | 1 | URL | |
| supplier_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 1384089486742271133 | BODY |
Exemples
Paramètres
// URL : /groups/1/suppliers/
group_id="1"
supplier_id="1384089486742271133"
Réponse
{
"success": true
}Paramètres
// URL : /groups/1/suppliers/
group_id="1"
supplier_id="1384089486742271133"
Réponse
<root>
<status>success</status>
</root>Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4119 | Unknown group |
| 401 | 4131 | Unauthorized email |
DELETE/groups/{group_id}/suppliersRetrait d'un fournisseur au groupe
Retire le fournisseur passé en paramètre du groupe passé en paramètre.
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| group_id | ID (Long) | ID du groupe | 1 | URL | |
| supplier_id | Siret (14 chiffres) ou ID (Long) | Siret ou ID d'une entité | 1384089486742271133 | URL |
Exemples
Paramètres
// URL : /groups/1/suppliers?supplier_id=1384089486742271133
group_id="1"
supplier_id="1384089486742271133"
Réponse
{
}Paramètres
// URL : /groups/1/suppliers?supplier_id=1384089486742271133
group_id="1"
supplier_id="1384089486742271133"
Réponse
<root>
</root>Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4019 | Invalid parameter SIRET or ID |
| 412 | 4119 | Unknown group |
| 401 | 4131 | Unauthorized email |
Evénements
GET/event/historyListe des événements
Retourne l'historique des événements d'un Acheteur
Paramètres
Si l'appel est fait par un Acheteur le champs buyer_id est obligatoire.
Si l'appel est fait par un Distributeur:
- le champs distributor_id est obligatoire
- l'un des deux champs integratedbuyer_id ou integratedbuyer_external_id est obligatoire afin d'identifier l'acheteur intégré
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID (Long) | ID d'un acheteur | 1384089486742271133 | URL | |
| distributor_id | ID (Long) | ID d'un distributeur (si appel distributeur) | 1384089486742271133 | URL | |
| integratedbuyer_id | ID (Long) | ID d'un acheteur intégré (si appel distributeur) | 1384089486742271133 | URL | |
| integratedbuyer_external_id | ID (String) | ID externe d'un acheteur intégré (si appel distributeur) | RGFT-1540 | URL | |
| level | Entier (1 ou 2) | Niveau d'interrogation (2 pour avoir accès aux relances téléphoniques) | 1 | 1 | URL |
| include_globals | Boolean (0 ou 1) | Indique si les événements globaux doivent être retournés | 1 | 1 | URL |
| include_emails | Boolean (0 ou 1) | Indique si les événements emails doivent être retournés | 1 | 1 | URL |
| include_phoning | Boolean (0 ou 1) | Indique si les relances téléphoniques doivent être retournés | 1 | 1 | URL |
| offset | Entier | Pagination sur les fournisseurs | 0 | 20 | URL |
| max | Entier | Nombre maximum de fournisseurs à retourner (50 au maximum) | 50 | 30 | URL |
Exemples
Paramètres
// URL : /events/history
buyer_id="1384089486742271133"
level="1"
max=2
Réponse
{
"buyer_id": 1384089486742271133,
"pagination": {
"offset": 0,
"max": 2,
"total": 20
},
"suppliers": [
{
"supplier": {
"id": 1802268668390812995,
"name": "SUP SOCIETE",
"siret": "78821382500508",
"globals": [
{
"event": {
"date": "2016-01-10T01:31:32Z",
"name": "Expiration d'un document : Attestation Urssaf",
"type": "expiration"
}
},
{
"event": {
"date": "2016-01-10T01:31:32Z",
"name": "Expiration d'un document : Kbis",
"type": "expiration"
}
}
],
"emails": [
{
"event": {
"date": "2016-01-10T01:31:35Z",
"name": "Notification d'expiration d'un document",
"type": "email",
"total_receivers": 2,
"referent_receivers": [
{
"contact": {
"email": "contact1@mail.fr"
}
}
],
"count_other_receivers": 1
}
},
{
"event": {
"date": "2016-01-10T01:31:35Z",
"name": "Notification d'expiration d'un document",
"type": "email",
"total_receivers": 2,
"referent_receivers": [
{
"contact": {
"email": "contact1@mail.fr"
}
}
],
"count_other_receivers": 1
}
}
],
"phoning": [
{
"event": {
"date": "2016-04-14T13:39:07Z",
"name": "Relance téléphonique",
"type": "téléphonique",
"user_joined": "mr dupont",
"cibled_update_date": "23/04/2016",
"compliance_department_presented": true,
"compliance_department_refused": false,
"invalid_message": "Données de contact manquantes ou erronées",
"comment": ""
}
}
]
}
},
{
"supplier": {
"id": 1802268668391027503,
"name": "SUP SOCIETE 2",
"siret": "41819991500020",
"globals": [],
"emails": [],
"phoning": []
}
}
]
}
Paramètres
// URL : /events/history
buyer_id="1384089486742271133"
level="1"
max=2
Réponse
<root>
<buyer_id>1384089486742271133</buyer_id>
<pagination>
<offset>0</offset>
<max>2</max>
<total>20</total>
</pagination>
<suppliers>
<supplier>
<id>1802268668390812995</id>
<name>SUP SOCIETE</name>
<siret>78821382500508</siret>
<globals>
<event>
<date>Sun Jan 10 02:31:32 CET 2016</date>
<name>Expiration d'un document : Attestation Urssaf</name>
<type>expiration</type>
</event>
<event>
<date>Sun Jan 10 02:31:32 CET 2016</date>
<name>Expiration d'un document : Kbis</name>
<type>expiration</type>
</event>
</globals>
<emails>
<event>
<date>Sun Jan 10 02:31:35 CET 2016</date>
<name>Notification d'expiration d'un document</name>
<type>email</type>
<total_receivers>2</total_receivers>
<referent_receivers>
<contact>
<email>contact1@mail.fr</email>
</contact>
</referent_receivers>
<count_other_receivers>1</count_other_receivers>
</event>
<event>
<date>Sun Jan 10 02:31:35 CET 2016</date>
<name>Notification d'expiration d'un document</name>
<type>email</type>
<total_receivers>2</total_receivers>
<referent_receivers>
<contact>
<email>contact1@mail.fr</email>
</contact>
</referent_receivers>
<count_other_receivers>1</count_other_receivers>
</event>
</emails>
<phoning>
<event>
<date>Thu Apr 14 15:39:07 CEST 2016</date>
<name>Relance téléphonique</name>
<type>téléphonique</type>
<user_joined>mr dupont</user_joined>
<cibled_update_date>23/04/2016</cibled_update_date>
<compliance_department_presented>true</compliance_department_presented>
<compliance_department_refused>false</compliance_department_refused>
<invalid_message>Données de contact manquantes ou erronées</invalid_message>
<comment></comment>
</event>
</phoning>
</supplier>
<supplier>
<id>1802268668391027503</id>
<name>SUP SOCIETE 2</name>
<siret>41819991500020</siret>
<globals></globals>
<emails></emails>
<phoning></phoning>
</supplier>
</suppliers>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4305 | distributor_id or buyer_id is required |
| 412 | 4308 | integratedbuyer_id or integratedbuyer_external_id is required |
| 412 | 4309 | Integrated buyer not found |
| 412 | 4311 | Given selection is empty |
Relances
POST/reminder/priorityEnvoyer une demande de mise à jour prioritaire
Envoie d'une demande de mise à jour prioritaire
Paramètres
Si l'appel est fait par un Acheteur le champs buyer_id est obligatoire.
Si l'appel est fait par un Distributeur:
- le champs distributor_id est obligatoire
- l'un des deux champs integratedbuyer_id ou integratedbuyer_external_id est obligatoire afin d'identifier l'acheteur intégré
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| buyer_id | ID (Long) | ID d'un acheteur | 1384089486742271133 | BODY | |
| distributor_id | ID (Long) | ID d'un distributeur (si appel distributeur) | 1384089486742271133 | BODY | |
| integratedbuyer_id | ID (Long) | ID d'un acheteur intégré (si appel distributeur) | 1384089486742271133 | BODY | |
| integratedbuyer_external_id | ID (String) | ID externe d'un acheteur intégré (si appel distributeur) | RGFT-1540 | BODY | |
| supplier_id | ID (Long) | ID du fournisseur à relancer | 1384089486742274583 | BODY | |
| contacts | String | Liste des contacts supplémentaire à notifier en plus des référents et des administrateurs. Séparé par des ";" | my@mail.com;your@mail.com | BODY | |
| text | String | Texte à envoyer | Le texte du mail par défaut | BODY |
Exemples
Paramètres
// URL : /reminder/priority
buyer_id="1384089486742271133"
supplier_id="1384088723742274589"
text="Le message de la relance"
contacts="mycontact1@mail.com;mycontact2@mail.com"
Réponse
{
"text": "Le message de la relance",
"subject": "Demande prioritaire de mise à jour sur Provigis (Rappel) par DO",
"contacts": [
{
"contact": {
"email": "mycontact1@mail.com"
}
},
{
"contact": {
"email": "mycontact2@mail.com"
}
},
{
"contact": {
"email": "mycontact3@mail.com"
}
}
]
}
Paramètres
// URL : /reminder/priority
buyer_id="1384089486742271133"
supplier_id="1384088723742274589"
text="Le message de la relance"
contacts="mycontact1@mail.com;mycontact2@mail.com"
Réponse
<root>
<contacts>
<contact>
<email>mycontact1@mail.com</email>
</contact>
<contact>
<email>mycontact2@mail.com</email>
</contact>
<contact>
<email>mycontact3@mail.com</email>
</contact>
</contacts>
<subject>Demande prioritaire de mise à jour sur Provigis (Rappel) par DO</subject>
<text>Le message de la relance</text>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 4305 | distributor_id or buyer_id is required |
| 412 | 4306 | supplier_id is required |
| 412 | 4307 | Given supplier not found |
| 412 | 4308 | integratedbuyer_id or integratedbuyer_external_id is required |
| 412 | 4309 | Integrated buyer not found |
| 412 | 4310 | Maximum reminder reached for this supplier |
Distributeurs
Utilisation des web servicesInformations
Les distributeurs ont accès à certains web services destinés aux donneurs d'ordres (acheteurs) :
De cette façon l'id externe peut être renseigné dans l'url: /buyers/{buyer_id}/suppliers donnera /buyers/myExternalId-xzvf/suppliers/.
Les id de groupes dans ces services doivent identifier un groupe distributeur lorsque l'appel est fait par un distributeur.
- GET /buyers/{buyer_id}/groups
- POST /buyers/{buyer_id}/suppliers
- DELETE /buyers/{buyer_id}/suppliers/{supplier_id}
- GET /buyers/{buyer_id}/status
- GET /buyers/{buyer_id}/suppliers
- GET /buyers/{buyer_id}/suppliers/{supplier_id}
De cette façon l'id externe peut être renseigné dans l'url: /buyers/{buyer_id}/suppliers donnera /buyers/myExternalId-xzvf/suppliers/.
Les id de groupes dans ces services doivent identifier un groupe distributeur lorsque l'appel est fait par un distributeur.
GET/distributors/{distributor_id}Organisation
Retourne l'organisation d'un distributeur, ses acheteurs intégrés et leurs fournisseurs
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| distributor_id | ID (Long) | ID d'un distributeur | 1384089486742271133 | URL | |
| level | Entier (1, 2 ou 3) | Niveau d'interrogation (1 pour les distributeurs, 2 pour les acheteurs intégrés, 3 pour les fournisseurs) | 1 | 2 | URL |
Exemples
Paramètres
// URL : /distributors/1802268668391070843
distributor_1="1802268668391070843"
level="3"
Réponse
{
"distributor": {
"id": "1802268668391070843",
"name": "distributeur 1",
"distributors": [
{
"distributor": {
"id": "1802268668391070848",
"name": "distributeur 1-A",
"distributors": [],
// Champs disponible si level >= 2
"integratedbuyers": [
{
"integratedbuyer": {
"id": "1802268668391070878",
"external_id": null,
"name": "AcheurIntegre1",
// Champs disponible si level = 3
"suppliers": [
{
"supplier": {
"id": "1802268668391070875",
"siret": "80252206000010",
"name": "RAISON SOCIALE 1"
}
}
]
}
},
{
"integratedbuyer": {
"id": "1802268668391070879",
"external_id": null,
"name": "AcheurIntegre2",
// Champs disponible si level = 3
"suppliers": [
{
"supplier": {
"id": "1802268668391070875",
"siret": "80252206000010",
"name": "RAISON SOCIALE 1"
}
}
]
}
}
]
}
}
],
// Champs disponible si level >= 2
"integratedbuyers": [
{
"integratedbuyer": {
"id": "1802268668391070948",
"external_id": "myExternalId-exid-123",
"name": "AcheurIntegre3",
// Champs disponible si level = 3
"suppliers": []
}
},
{
"integratedbuyer": {
"id": "1802268668391070950",
"external_id": "myExternalId-exid-1234",
"name": "AcheurIntegre3",
// Champs disponible si level = 3
"suppliers": [
{
"supplier": {
"id": "1802268668391070951",
"siret": "49458122600011",
"name": "RAISON SOCIALE 3"
}
},
{
"supplier": {
"id": "1802268668391070952",
"siret": "31232906300019",
"name": "RAISON SOCIALE 4"
}
}
]
}
}
]
}
}
Paramètres
// URL : /distributors/1802268668391070843
distributor_1="1802268668391070843"
level="3"
Réponse
<root>
<distributor>
<id>1802268668391070843</id>
<name>distributeur 1</name>
<distributors>
<distributor>
<id>1802268668391070848</id>
<name>distributeur 1-A</name>
<distributors></distributors>
<!-- Champs disponible si level >= 2 -->
<integratedbuyers>
<integratedbuyer>
<id>1802268668391070878</id>
<external_id/>
<name>AcheurIntegre1</name>
<!-- Champs disponible si level = 3 -->
<suppliers>
<supplier>
<id>1802268668391070875</id>
<siret>80252206000010</siret>
<name>RAISON SOCIALE 1</name>
</supplier>
</suppliers>
</integratedbuyer>
<integratedbuyer>
<id>1802268668391070879</id>
<external_id/>
<name>AcheurIntegre2</name>
<!-- Champs disponible si level = 3 -->
<suppliers>
<supplier>
<id>1802268668391070875</id>
<siret>80252206000010</siret>
<name>RAISON SOCIALE 1</name>
</supplier>
</suppliers>
</integratedbuyer>
</integratedbuyers>
</distributor>
</distributors>
<!-- Champs disponible si level >= 2 -->
<integratedbuyers>
<integratedbuyer>
<id>1802268668391070948</id>
<external_id>myExternalId-exid-1</external_id>
<name>AcheurIntegre3</name>
<!-- Champs disponible si level = 3 -->
<suppliers></suppliers>
</integratedbuyer>
<integratedbuyer>
<id>1802268668391070950</id>
<external_id>myExternalId-exid-12</external_id>
<name>AcheurIntegre4</name>
<!-- Champs disponible si level = 3 -->
<suppliers>
<supplier>
<id>1802268668391070951</id>
<siret>49458122600011</siret>
<name>RAISON SOCIALE 3</name>
</supplier>
<supplier>
<id>1802268668391070952</id>
<siret>31232906300019</siret>
<name>RAISON SOCIALE 4</name>
</supplier>
</suppliers>
</integratedbuyer>
</integratedbuyers>
</distributor>
</root>
POST/distributors/{distributor_id}/integrated_buyerAjout d'un acheteur intégré
Ajoute un acheteur intégré à un distributeur
Paramètres
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| distributor_id | ID (Long) | ID d'un distributeur | 1384089486742271133 | URL | |
| integratedbuyer_name | String | Nom de l'acheteur intégré | Acheteur Intégré 1 | BODY | |
| integratedbuyer_external_id | String | Id externe de l'acheteur intégré | XVF-ID | BODY | |
| integratedbuyer_siret | String | Siret de l'acheteur intégré. Requis pour créer la version fournisseur ! | 123456789000125 | BODY | |
| integratedbuyer_create_supplier | Boolean (0, 1) | Une version fournisseur de l'acheteur intégré doit-elle être créée ? Si oui, le champs integratedbuyer_siret doit être renseigné. | 0 | 1 | BODY |
| integratedbuyer_attach_supplier | Boolean (0, 1) | La version fournisseur créée doit-elle être attachée à l'acheteur intégré ? Pris en compte uniquement si integratedbuyer_create_supplier | 0 | 1 | BODY |
Exemples
Paramètres
// URL : /distributors/1802268668391070843/integrated_buyer
distributor_id="1802268668391070843"
integratedbuyer_name="Acheteur Intégré name"
integratedbuyer_external_id="VRF-234"
integratedbuyer_siret="50270292100011"
integratedbuyer_create_supplier=1
integratedbuyer_attach_supplier=1
Réponse
{
"action": "SETUP", // SETUP ou NONE
"id": "1802268668391070865",
"external_id": "VRF-234",
"name": "Acheteur Intégré name",
// Champs disponible si integratedbuyer_create_supplier = 1
"supplier": {
"action": "SETUP", // CREATED, SETUP, RENEWAL ou NONE
"id": "1802268668391070857",
"name": "Acheteur Intégré name",
"siret": "50270292100011"
}
}
Paramètres
// URL : /distributors/1802268668391070843/integrated_buyer
distributor_id="1802268668391070843"
integratedbuyer_name="Acheteur Intégré name"
integratedbuyer_external_id="VRF-234"
integratedbuyer_siret="50270292100011"
integratedbuyer_create_supplier=1
integratedbuyer_attach_supplier=1
Réponse
<root>
<action>SETUP</action> <!-- SETUP, NONE -->
<id>1802268668391070865</id>
<external_id>VRF-234</external_id>
<name>Acheteur Intégré name</name>
<!-- Champs disponible si integratedbuyer_create_supplier = 1 -->
<supplier>
<action>SETUP</action> <!-- CREATED, SETUP, RENEWAL ou NONE -->
<id>1802268668391070857</id>
<name>Acheteur Intégré name</name>
<siret>50270292100011</siret>
</supplier>
</root>
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 1200 | Integrated buyer name is required |
| 412 | 1201 | External id must be unique in organization, duplication detected |
| 412 | 1203 | This integrated buyer does not belong your organization |
| 412 | 1204 | This integrated does not have SIRET, can't create supplier version |
| 412 | 1206 | This integrated has not a valid SIRET, can't create supplier version |
| 412 | 1205 | A SIRET is required to create supplier version of integrated buyer |
| 412 | 1207 | Valid SIRET is required to create supplier version of integrated buyer |
| 412 | 1301 | Invalid SIRET for supplier |
DELETE/distributors/{distributor_id}/integrated_buyerSuppression d'un acheteur intégré
Supprime un acheteur intégré à un distributeur
Paramètres
L'un des deux champs integratedbuyer_id et integratedbuyer_external_id doit être renseigné. Si les deux sont renseignés, seul integratedbuyer_external_id sera exploité.
| Paramètre | Contrainte | Description | Valeur par défaut | Exemple | Type |
|---|---|---|---|---|---|
| distributor_id | ID (Long) | ID d'un distributeur | 1384089486742271133 | URL | |
| integratedbuyer_external_id | String | Id externe de l'acheteur intégré | XVF-ID | BODY | |
| integratedbuyer_id | String | Id Provigis de l'acheteur intégré | 1384458137742278762 | BODY | |
Exemples
Paramètres
// URL : /distributors/1802268668391070843/integrated_buyer
distributor_id="1802268668391070843"
integratedbuyer_external_id=extern-id-rvfd
Réponse
{
"action": "DELETE",
"id": 1802268668391076514,
"external_id": "extern-id-rvfd",
"name": "Un Acheteur Intégré"
}
Paramètres
// URL : /distributors/1802268668391070843/integrated_buyer
distributor_id="1802268668391070843"
integratedbuyer_external_id=extern-id-rvfd
Réponse
DELETE
1802268668391076514
extern-id-rvfd
Un Acheteur Intégré
Erreur
| Code HTTP | Code erreur | Message |
|---|---|---|
| 412 | 3100 | Missing integrated buyer identification |
| 412 | 3101 | Given integrated buyer not found |
| 412 | 3102 | Given integrated buyer does not belong your organization |