NAV Navbar
xml

API WebServices SOAP v3 - e-Attestations

Présentation

L'API WebServices SOAP v3 est utilisée pour interfacer un système d'information 'client' à la plate-forme d'e-Attestations suivant le protocole SOAP.

Cette API WebServices présente un ensemble de méthodes permettant d'administrer (importer, suivre, archiver, etc...) les dossiers de suivi de conformité des tiers du compte client et de restituer des informations. La majorité des opérations sont synchrônes.

Vous cherchez une API REST ?

Découvrez toutes nos APIs, nos outils et autre ressource sur https://e-attestations.io.

Objectifs de cette documentation

Standards

Les WebServices e-Attestations reposent sur le standards SOAP 1.1.

Norme Source
Simple Objet Access Protocol (SOAP) 1.1 http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
Web Service Description Language (WSDL) 1.1 http://www.w3.org/TR/2001/NOTE-wsdl-20010315
WS-I Basic Profile 1.1 http://www.ws-i.org/Profiles/BasicProfile-1.1.html

Les WebServices implémentent WS-Security permettant l'identification de l'agent émetteur de l'appel dans le système. Pour plus d'informations, voir Mode d'identification.

Namespaces SOAP

Prefix Namespace
S11 http://schemas.xmlsoap.org/soap/envelope/
wsse http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-secext-1.0.xsd
wsu http://docs.oasis-open.org/wss/2004/01/oasis-200401-wsswssecurity-utility-1.0.xsd

Mise en place

Pour souscrire à l'un ou l'autre des environnements vous devez tout d'abord en émettre la demande auprès de votre gestionnaire de compte e-Attestations.com habituel.

Nous vous conseillons de bien discuter de la configuration de votre compte en terme de document de compliance bien en amont et notamment pour votre gestionnaire de compte puisse parfaitement comprendre votre cas d'usage et vous conseiller au mieux.

Attention : L'usage des WebServices n'est pas multicomptes.

Votre gestionnaire de compte informera l'équipe technique pour la création d'une organisation liée à votre compte et un ou plusieurs contacts techniques (emails) seront alors invités au Tech'Desk e-Attestations.com.

Le support Tech'Desk e-Attestations

Ce système de ticketing et de support TECHNIQUE dédié au API et WebServices e-Attestations où poster questions et demandes.

Pour créer un ticket envoyez simplement un email à l'adresse api@eattestationscom.zohodesk.eu

Cette plateforme sécurisée vous permet aussi de partager dans votre organisation les tickets de support.

Note : les users et mots de passe de connexion ne sont fournis que dans le Tech'Desk.

Collection Postman

Exemple d'utilisation de newman

 npx newman run "EA_WebServices_v3.postman_collection.json" \
 --global-var wsuser="<user>" \
 --global-var wspassword="<password>" \
 --global-var ws_siret="<SIRET>" \
 --global-var ws_ref_dossier="<NOM DOSSIER>" \
 --global-var wsurl="https://ws-test.dev-e-attestations.com"

Pour aller encore plus vite et faciliter l'intégration et l'exploration de notre API WebService SOAP v3 nous fournissons une collection Postman que vous pouvez importer dans postman et tester rapidement.

Vous devrez définir quelques variables (wsuser, wspassword et wsurl) aussi qu'un SIRET de test et un nom de dossier pour exploiter cette suite de test.

Vous pouvez aussi explorer chacun des scenari pour foncionnellement comprendre les usages possible de l'API WebServices.

Vous pouvez télécharger Postman via ce lien ou utiliser newman via ce lien.

Environnements

e-Attestations met à disposition deux environnements :

ATTENTION : dans l'environnement de TEST et afin d'éviter que vos tests n'interfèrent pas avec votre activité de production les envois d'emails sont inhibés (pas d'invitation de rapports ou d'alerte).

Environnement URL
TEST https://ws.test-e-attestations.com/v3.0/EAttestationsWS?wsdl
PRODUCTION https://ws.e-attestations.com/v3.0/EAttestationsWS?wsdl

Sécurité

A votre demande (via le Tech'Desk) un identifiant et un mot de passe vous sera transmis pour effectuer l'authentification de vos requêtes vers les WebServices.

Chaque requête est authentifiée et un mécanisme de filtrage de confiance par adresse IP (whitelist) permet de garantir la légitimité du système client à accéder au WebServices. Ainsi, il faudra toujours préciser les adresses IP de vos infrastructures clientes.

Il est conseillé de rendre ces identifiants et le lien du service paramétrable pour pouvoir facilement basculer d'une plate-forme à l'autre.

Les échanges sont sécurisés par un chiffrement SSL/TLS pour les protocoles TLS 1.1 et TLS 1.2.

Sécurité renforcée par Trust IP

Lors de la souscription au service WebService vous devez communiquer les adresses IP des serveurs 'client' et qui consommeront les WebServices.

Si vous avez une ou plusieurs serveurs clients, il faut que chaque adresse IP soit communiquée pour qu'elle soit ajoutée à la liste des IP de confiance (Trust IP) d'e-Attestations.

L'adresse IP doit être fournie par serveur sous la forme d'un CIDR.

Par exemple : 34.56.78.90/32 le /32 désigne la masque pour une adresse IP unique.

En cas d'erreur HTTP 403

Exemple d'erreur 403 :

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> 
<html> 
  <head> 
    <title>403 Forbidden</title> 
  </head> 
  <body> 
    <h1>Forbidden</h1> 
    <p>You don't have permission to access [...] on this server.</p> 
  </body> 
</html>

Si une requête vers une méthode renvoit un erreur avec un code d'erreur HTTP 403, ceci pour tout méthode, cela signifie que le serveur client qui a effectué l'appel a une adresse IP qui n'est pas sur la liste de confiance.

Ainsi, vérifiez que l'adresse IP qui émet la requête a bien été déclarée auprès d'e-Attestations.

Nous vous invitons à poster une requête sur le Tech'Desk en cas de doûte.

Authentification

Exemple d'authentification

<S11:Envelope xmlns:S11="..." xmlns:wsse="..."> 
    <S11:Header> 
        ... 
        <wsse:Security> 
            <wsse:UsernameToken> 
                <wsse:Username>myUsername</wsse:Username> 
                <wsse:Password Type="...#PasswordDigest"> 
                   weYI3nXd8LjMNVksCKFV8t3rgHh3Rw== 
                </wsse:Password> 
                <wsse:Nonce EncodingType="...#Base64Binary"> 
                   WScqanjCEAC4mQoBE07sAQ== 
                </wsse:Nonce> 
                <wsu:Created>2003-07-16T01:24:32Z</wsu:Created> 
            </wsse:UsernameToken> 
        </wsse:Security> 
        ... 
    </S11:Header> 
    ... 
</S11:Envelope>

Chaque appel au web service nécessite un couple username/password valide. Celui-ci vous est transmis lors de l'ouverture de votre compte Web Services.

Il doit être renseigné dans le header du message SOAP sous forme de UsernameToken.

Dans cet exemple, le mot de passe est de type PasswordDigest. Il peut aussi être de type PasswordText.

L'utilisation du type PasswordDigest est conseillée car plus sécurisée. Il s'agit d'un hash créé à partir du mot de passe initial, de la date (Created) et d'un nombre généré aléatoirement (Nonce).

Nous vous invitons à consulter la documentation de référence de SAOP WS Security pour plus d'information : http://docs.oasis-open.org/wss-m/wss/v1.1.1/os/wss-SOAPMessageSecurity-v1.1.1-os.html

Pour plus d'informations, voir Web Services Security UsernameToken Profile 1.1.

Réponse d'erreur d'autentification

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> 
   <soap:Body> 
      <soap:Fault> 
         <faultcode>soap:Server</faultcode> 
         <faultstring>Échec d'authentification</faultstring> 
         <detail/> 
      </soap:Fault> 
   </soap:Body> 
</soap:Envelope>

En cas d'erreur

En cas d'erreur d'authentification, vérifiez si :

Méthodes Web Services v3

Sont explicitées ici l'ensemble des méthodes servies et présentées par le WSDL (Web Services Description Language) WebServices V3

Lien vers le WSDL (accessible par les IP trustées) : https://ws.e-attestations.com/v3.0/EAttestationsWS?wsdl

Représentation HTML du WSDL : WSDL documentation

Méthode Description
importDossier Activer le suivi d'un dossier dans e-Attestations
getImportDossierResult Obtenir le résultat d'un import
getSupplierIdentifierList Restituer les identifiants des fournisseurs du référentiel
getDossier Restituer les informations d'un ou plusieurs dossiers
getSupplierAccountInformation Restituer les informations d'un fournisseur
getGlobalInformation Restituer des statistiques globales sur le compte
getAvailableDocuments Restituer la liste des documents autorisés
updateDossier Mettre à jour les informations d'un dossier
updateRequiredDocuments Mettre à jour la liste des documents demandés pour un dossier
stopDossier Arrêter le suivi d'un dossier
reactivateDossier Reactiver un dossier

Format standard des réponses

Les réponses sont standardisées, structurée en une composition de d'objet Result et Error.

Ces réponses doivent être analysés par les applications clients de ces API afin de mettre en oeuvre une logique métier appropriée. L'intégration des WebServices et les développements clients doivent tirer pleinement partie de ces éléments de réponses pour proposer la meilleur expérience utilisateur finale.

Format de Result

Attributs Type Description Non nul
complete Boolean True = Traitement terminé Oui
success Boolean True = Traitement réalisé avec succès, False sinon Oui
listErrors List<Error> Liste des erreurs Non

Format de Error

Attributs Type Description Non nul
code String Code de l'erreur. Cf Codes d'erreur et signification). Oui
additional String Information complémentaire au code d'erreur. Non

Description des méthodes

Sont explicitées ici l'ensemble des appels aux méthodes et leur réponses.

Les codes d'erreur ou les format communs sont tous regroupés en fin de documentation.

importDossier

La méthode ìmportDossier` permet l'import/la création d'un dossier pour un tiers : elle permet donc d'activer le suivi pour les pièces demandées pour le dossier de ce fournisseur.

Le traitement pouvant durer plusieurs minutes la réponse est donc asynchrone.

Ainsi la méthode renvoie un identifiant de suivi du traitement de l'import qu'il faudra utiliser pour connaître le résultat de l'import.

La méthode getImportDossierResult permet de suivre le résultat de l'import grace à l'identifiant de travail renvoyé par la méthode importDossier.

Il est important :

graph TB A((Start)) A --> B(Call importDossier
returns processId) B --processId--> C(Call getImportDossierResult for processId) C --> D{Status} D --complete=true
AND success=true--> E D --complete=true
AND success=false--> R D --complete=false--> C E((End)) R(Error Handling)

Points d'attentions

Request

Exemple de requete

<soapenv:Envelope 
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:srv="http://srv.v3.ws.ea.com/">
  <soapenv:Header />
  <soapenv:Body>
    <srv:importDossier>
      <dossierImport>
        <supplierImport>
          <companyIDType>CIT001</companyIDType>
          <companyIDValue>50382936800037</companyIDValue>
          <supplierCode>SC_001</supplierCode>
        </supplierImport>
        <dossierReference>REF_001</dossierReference>
        <expirationDate>2015-12-31</expirationDate>
        <description>This is my description</description>
        <purchasingCategory>Category n°1</purchasingCategory>
        <requiredDocuments>ATT_VIGI</requiredDocuments>
        <requiredDocuments>JUSTIF_IMM</requiredDocuments>
        <requiredDocuments>ASSUR_RCPRO</requiredDocuments>
        <supplierEmail>test@e-attestations.com</supplierEmail>
        <userInCharge>test@mydomain.com</userInCharge>
      </dossierImport>
    </srv:importDossier>
  </soapenv:Body>
</soapenv:Envelope>

DossierImport

Attributs Type Description Obligatoire
supplierImport SupplierImport Informations pour identifier le fournisseur. Oui
dossierReference String Référence du dossier pour ce fournisseur. La référence doit être unique pour un même fournisseur. Oui
expirationDate Date Date d'expiration du dossier. Non
description String Description du dossier. Non
purchasingCategory String Catégorie achat du dossier. Non
requiredDocuments String[] Liste des codes des documents demandés pour ce dossier. Si aucun document n'est renseigné, le set de documents par défaut est demandé. Non
supplierEmail String Un ou plusieurs E-mails (séparés par des ; ) de contact du fournisseur. Il est recommandé de renseigner l'e-mail de la personne susceptible de déposer les pièces. Non
userInCharge String Un ou plusieurs E-mails (séparés par des ; ) de responsable dossier côté donneur d'ordre. Ces personnes seront invitées à adhérer à la plate-forme donneur d'ordre d'e-Attestations. Non

SupplierImport

Attributs Type Description Obligatoire
companyIDType String Type d'identifiant de l'entreprise (cf 3.2 Codes d'identification d'une entreprise) : CIT001, CIT002 ou CIT003 Oui
companyIDValue String Valeur de l'identifiant de l'entreprise. Oui
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non

Exemple de réponse

<soap:Envelope 
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns1:importDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
      <return xmlns:ns2="http://srv.v3.ws.ea.com/">
        ff8081814f6e43ab014f6e4571630004
        </return>
    </ns1:importDossierResponse>
  </soap:Body>
</soap:Envelope>

Response

Attributs Type Description NOT NULL
processId String Identifiant de la demande d'import. YES

Errors

Le traitement est contôlé via la méthode getImportDossierResult et ne produit pas de code d'erreur.

getImportDossierResult

Exemple de requete

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:srv="http://srv.v3.ws.ea.com/"> 
   <soapenv:Header/> 
   <soapenv:Body> 
      <srv:getImportDossierResult> 
         <processId>ff8081814f6e43ab014f6e4571630004</processId> 
      </srv:getImportDossierResult> 
   </soapenv:Body> 
</soapenv:Envelope>

Cette méthode permet de connaître le résultat d'un import à partir de son identifiant.

Request

Attributs Type Description Obligatoire
processId String Identifiant de la demande d'import. Oui

Exemples de réponse en stade IN PROGRESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns1:getImportDossierResultResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
            <return xmlns:ns2="http://srv.v3.ws.ea.com/">
                <complete>false</complete>
                <success>false</success>
            </return>
        </ns1:getImportDossierResultResponse>
    </soap:Body>
</soap:Envelope>

Exemples de réponse en SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns1:getImportDossierResultResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
            <return xmlns:ns2="http://srv.v3.ws.ea.com/">
                <complete>true</complete>
                <success>true</success>
            </return>
        </ns1:getImportDossierResultResponse>
    </soap:Body>
</soap:Envelope>

Exemple de réponse en ECHEC

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns1:getImportDossierResultResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
            <return xmlns:ns2="http://srv.v3.ws.ea.com/">
                <complete>true</complete>
                <listErrors>
                    <additional>REF_001</additional>
                    <code>E202</code>
                </listErrors>
                <success>false</success>
            </return>
        </ns1:getImportDossierResultResponse>
    </soap:Body>
</soap:Envelope>

Response

Attributs Type Description Non vide
processId String Identifiant de la demande d'import. Oui

getSupplierIdentifierList

Cette méthode permet de remonter l'ensemble des identifiants du référentiel fournisseur.

Exemple de requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:srv="http://srv.v3.ws.ea.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <srv:getSupplierIdentifierList>
            <supplierIdentifierSearch>
                <monitoredSupplier>true</monitoredSupplier>                
            </supplierIdentifierSearch>
        </srv:getSupplierIdentifierList>
    </soapenv:Body>
</soapenv:Envelope>

supplierIdentifierSearch

Attributs Type Description Obligatoire
monitoredSupplier Boolean Filtre pour ne retourner que des fournisseurs suivis (true) ou non (false). Non
stateLastChangeDate Date Filtre pour ne retourner que des fournisseurs dont l'état de complétude global a été modifié depuis la date renseignée. Non
supplierGlobalState Boolean Filtre pour ne retourner que des fournisseurs dont l'état de complétude global est complet (true) ou non (false). Non
subscriptionState Boolean Filtre pour ne retourner que des fournisseurs dont l'état d'inscription est inscrit (true) ou non inscrit (false). Non

Exemple de réponse : SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns1:getSupplierIdentifierListResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
            <return xmlns:ns2="http://srv.v3.ws.ea.com/">
                <supplierIdentifier>
                    <companyIDType>CIT001</companyIDType>
                    <companyIDValue>50382936800037</companyIDValue>
                    <supplierCode>SC_001</supplierCode>
                </supplierIdentifier> 
        </ns1:getSupplierIdentifierListResponse>
    </soap:Body>
</soap:Envelope>

Exemple de réponse : FAIL

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns1:getSupplierIdentifierListResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
            <return xmlns:ns2="http://srv.v3.ws.ea.com/">
                <result>
                    <complete>true</complete>
                    <listErrors>
                        <additional>stateLastChangeDate</additional>
                        <code>E022</code>
                    </listErrors>
                    <success>false</success>
                </result>
            </return>
        </ns1:getSupplierIdentifierListResponse>
    </soap:Body>
</soap:Envelope>

Response

Attributs Type Description NULL
result Result Statut de l'appel et liste des erreurs en cas d'échec. Oui
supplierIdentifierList List<SupplierIdentifier> Informations retournées en cas de succès. Non

SupplierIdentifier

Attributs Type Description NULL
companyIDType String Type d'identifiant de l'entreprise (cf 3.2 Codes d'identification d'une entreprise). Oui
companyIDValue String Valeur de l'identifiant de l'entreprise. Oui
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non

getDossier

Cette méthode permet de récupérer les informations d'un ou plusieurs dossiers en fonction des paramètres de recherche.

Il est possible combiner/cumuler différents filtres et critère de recherches afin de répondre à votre besoin.

Attention : l'accumulation de critère de recherche renforce les filtres ce qui peut aboutir à des réponses vides à mesure de la multiplication des critères.

Les informations renvoyées

Exemples d'utilisation:

Paramètres d'appel

Exemple d'appel

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:srv="http://srv.v3.ws.ea.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <srv:getDossier>
            <dossierSearch>
                <supplierSearch>
                    <companyIDType>CIT001</companyIDType>
                    <companyIDValue>48088206700014</companyIDValue>
                </supplierSearch>
                <dossierReference>REF001</dossierReference>
            </dossierSearch>
        </srv:getDossier>
    </soapenv:Body>
</soapenv:Envelope>

DossierSearch

Attributs Type Description Obligatoire
supplierSearch SupplierSearch Informations pour identifier le fournisseur du (ou des) dossier(s) à restituer. Oui
dossierReference String Filtre pour ne retourner qu'un dossier : référence du dossier. Ce paramètre nécessite un filtre fournisseur. Non
monitoredDossier Boolean Filtre pour ne retourner que des dossiers actifs (true) ou désactivés (false). Non
stateLastChangeDate Date Filtre pour ne retourner que des dossiers dont l'état de complétude global a été modifié depuis la date renseignée. Non

SupplierSearch

Attributs Type Description Obligatoire
companyIDType String Type d'identifiant de l'entreprise (cf 3.2 Codes d'identification d'une entreprise): CIT001, CIT002 ou CIT003 Non*
companyIDValue String Valeur de l'identifiant de l'entreprise. Non*
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non*

Structure des informations renvoyées

la méthode getDossier est la méthode permettant la récupération des informations relatives au suivi de la conformité d'un tiers et à ce titre permet de récupérer un maximum d'informations.

Voici une représentation du la structure des informations renvoyées :

Exemple de réponse 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ns1:getDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
      <return xmlns:ns2="http://srv.v3.ws.ea.com/">
        <result>
          <complete>true</complete>
          <success>true</success>
        </result>
        <supplier>
          <companyCountryCode>FRA</companyCountryCode>
          <companyIDType>CIT001</companyIDType>
          <companyIDValue>48088206700014</companyIDValue>
          <listDossiers>
            <description>Ma nouvelle description renseignée par Web Service</description>
            <dossierGlobalState>false</dossierGlobalState>
            <dossierGlobalStateLastChangeDate>2016-02-11T11:57:40.094+01:00</dossierGlobalStateLastChangeDate>
            <dossierId>57512</dossierId>
            <dossierReference>REF001</dossierReference>
            <listDocuments>
              <askingDate>2016-02-11T11:57:40.270+01:00</askingDate>
              <documentCode>JUSTIF_IMM</documentCode>
              <listFileInformation>
                <downloadLink>https://ws-test.e-attestations.com/webservices/download/[...]</downloadLink>
                <expirationDate>2018-08-02T23:59:59.999+02:00</expirationDate>
                <uploadDate>2018-02-02T01:30:17.634+01:00</uploadDate>
              </listFileInformation>
              <name>Justificatif d’immatriculation</name>
              <present>true</present>
            </listDocuments>
            <listDocuments>
              <askingDate>2016-02-11T11:57:40.515+01:00</askingDate>
              <documentCode>ATT_VIGI</documentCode>
              <name>Attestation de vigilance (6 mois)</name>
              <present>false</present>
            </listDocuments>
            <listDocuments>
              <askingDate>2016-02-11T11:57:40.120+01:00</askingDate>
              <documentCode>LST_SAL_ETR</documentCode>
              <name>Liste nominative des salariés étrangers soumis à autorisation de travail</name>
              <present>false</present>
            </listDocuments>
            <listDocuments>
              <askingDate>2017-10-10T10:33:21.074+02:00</askingDate>
              <documentCode>ATT_PRO_BTP</documentCode>
              <name>Attestation de cotisation retraite</name>
              <present>false</present>
            </listDocuments>
            <listIndicators>
              <indicatorCode>I001</indicatorCode>
              <lastChangeDate>2016-02-11T11:57:40.094+01:00</lastChangeDate>
              <state>false</state>
            </listIndicators>
            <monitoredDossier>true</monitoredDossier>
            <purchasingCategory/>
            <startingDate>2016-02-11T11:57:40.092+01:00</startingDate>
          </listDossiers>
          <monitoredSupplier>true</monitoredSupplier>
          <supplierCode>A-GRAPH</supplierCode>
          <supplierGlobalState>false</supplierGlobalState>
          <supplierGlobalStateLastChangeDate>2016-02-11T11:57:40.257+01:00</supplierGlobalStateLastChangeDate>
        </supplier>
      </return>
    </ns1:getDossierResponse>
  </soap:Body>
</soap:Envelope>

Format WSDL -> Liste

Response

Attributs Type Description Non nul
result Result Statut de l'appel et liste des erreurs en cas d'échec. Oui
supplier Supplier Informations retournées en cas de succès. Non

Supplier

Attributs Type Description Non nul
companyIDType String Type d'identifiant de l'entreprise (cf 3.2 Codes d'identification d'une entreprise). Oui
companyIDValue String Valeur de l'identifiant de l'entreprise. Oui
companyCountryCode String Pays de l'entreprise identifié par le code alpha-3 du standard ISO 3166-1. Oui
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non
monitoredSupplier Boolean True si fournisseur suivi, false sinon. Un fournisseur est suivi dès lors qu'il a au moins un dossier actif. Oui
supplierGlobalState Boolean État de complétude global du fournisseur. True si tous les documents demandés au fournisseur (tout dossier confondu) sont présents, false sinon. Null si fournisseur non suivi. Non
supplierGlobalStateLastChangeDate Date Date de dernier changement de complétude de l'ensemble des documents demandés pour l'ensemble des dossiers. Null si fournisseur non suivi. Non
listDossiers List<Dossier> Ensemble des informations sur les dossiers du fournisseurs qui correspondent aux filtres de recherche. Oui

Dossier

Attributs Type Description Non nul
dossierReference String Référence du dossier pour ce fournisseur. La référence doit être unique pour un même fournisseur. Oui
dossierId String Référence unique et non modifiable (id généré par le système à la création) du dossier de ce fournisseur. Oui
startingDate Date Date de création, d'import, de début de suivi du dossier. Oui
expirationDate Date Date d'expiration du dossier. Null si pas de date d'expiration. Non
stoppingDate Date Date d'arrêt du dossier. Non nul uniquement si dossier désactivé. Non
stoppingReason String Détail concernant l'arrêt du dossier : OUTOFBUSINESS (entreprise radiée), EXPIRATION (le dossier a atteint sa date d'expiration), STOPREQUEST (une demande d'arrêt a été faite de manière explicite et immédiate), UNKNOWN (information absente). Non nul uniquement si dossier désactivé. Non
description String Description du dossier. Non
purchasingCategory String Catégorie achat du dossier. Non
monitoredDossier Boolean True si le dossier est actif, false sinon. Oui
dossierGlobalState Boolean État de complétude du dossier. True si l'ensemble des documents demandés pour le dossier sont présents, false sinon. Null si le dossier est désactivé. Non
dossierGlobalStateLastChangeDate Date Date de dernier changement de complétude du dossier. Null si le dossier est désactivé. Non
listIndicators List<Indicator> Liste des indicateurs du dossier. Non
listDocuments List<Document> Liste des documents demandés pour le dossier. Non

Indicator

Attributs Type Description Non nul
indicatorCode String Code de l'indicateur (cf 3.3 Codes d'indicateur) Oui
state Boolean État de l'indicateur. True si l'ensemble des documents demandés de l'indicateur sont présents, false sinon. Oui
lastChangeDate Date Date de dernier changement de l'état de l'indicateur. Oui

Document

Attributs Type Description Non nul
documentCode String Code qui identifie le document. Il est unique et non modifiable. Oui
name String Nom du document. Il peut évoluer avec le temps. Oui
askingDate Date Date à laquelle le document a été demandé. Oui
present Boolean État de complétude du document. True si un document est présent et valide, false sinon. Pour les documents multiples au moins un est présent. Oui
listFileInformation List<FileInformation> Informations du (ou des) documents présents. Non

FileInformation

Attributs Type Description Non nul
downloadLink String Lien de téléchargement du fichier. Important, ce lien est uniquement accessible au serveur autorisé par IP. i.e. le téléchargement direct par le navigateur client est interdit. Oui
uploadDate Date Date de dépôt du document. Oui
expirationDate Date Date d'expiration du document. Non

getSupplierAccountInformation

Cette méthode permet de remonter les informations d'identité d'un tier déclarant.

Elles remontent également les informations concernant les personnes inscrites pour le compte de ce déclarant et qui sont inscrits à e-Attestations.

Exemple de requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:srv="http://srv.v3.ws.ea.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <srv:getSupplierAccountInformation>
         <supplierSearch>
            <!--<companyIDType></companyIDType>-->
            <!--<companyIDValue></companyIDValue>-->
            <supplierCode>SC_001</supplierCode>
         </supplierSearch>
      </srv:getSupplierAccountInformation>
   </soapenv:Body>
</soapenv:Envelope>

supplierSearch

Attributs Type Description Obligatoire
companyIDType String Type d'identifiant de l'entreprise (cf 3.2 Codes d'identification d'une entreprise). Non*
companyIDValue String Valeur de l'identifiant de l'entreprise. Non*
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non*

Exemple de réponse SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:getSupplierAccountInformationResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <result>
               <complete>true</complete>
               <success>true</success>
            </result>
            <supplierAccountInformation>
               <addressCity>PARIS 14</addressCity>
               <addressCountryCode>FRA</addressCountryCode>
               <addressPostCode>75014</addressPostCode>
               <addressStreet>VLA DE LOURCINE</addressStreet>
               <companyCountryCode>PARIS 14</companyCountryCode>
               <companyIDType>CIT001</companyIDType>
               <companyIDValue>50382936800037</companyIDValue>
               <monitoredSupplier>false</monitoredSupplier>
               <name>E-ATTESTATIONS.COM</name>
               <outOfBusiness>false</outOfBusiness>
               <subscriptionDate>2010-11-24T10:38:32.224+01:00</subscriptionDate>               <subscriptionState>true</subscriptionState>               <subscriptionKey>SXBQNTXKK6VM</subscriptionKey>
               <supplierCode>SC_001</supplierCode>
               <supplierUsers>
                  <email>e.poidevin@e-attestations.com</email>
                  <firstName>Emmanuel</firstName>
                  <internationalPhone>+33 1 58 06 00 23</internationalPhone>
                  <lastName>Poidevin</lastName>
               </supplierUsers>
               <supplierUsers>
                  <email>rapportdo@e-attestations.com</email>
                  <firstName>Admin</firstName>
                  <internationalPhone>+33 1 58 06 00 10</internationalPhone>
                  <lastName>Admin</lastName>
               </supplierUsers>
            </supplierAccountInformation>
         </return>
      </ns1:getSupplierAccountInformationResponse>
   </soap:Body>
</soap:Envelope>

Exemple de réponse FAIL

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:getSupplierAccountInformationResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <result>
               <complete>true</complete>
               <listErrors>
                  <code>E100</code>
               </listErrors>
               <success>false</success>
            </result>
         </return>
      </ns1:getSupplierAccountInformationResponse>
   </soap:Body>
</soap:Envelope>

Response

Attributs Type Description NULL
result Result Statut de l'appel et liste des erreurs en cas d'échec. Oui
supplierAccountInformation SupplierAccountInformation Informations retournées en cas de succès. Non

SupplierAccountInformation

Attributs Type Description NULL
companyIDType String Type d'identifiant de l'entreprise (cf 3.2 Codes d'identification d'une entreprise) Oui
companyIDValue String Valeur de l'identifiant de l'entreprise. Oui
companyCountryCode String Pays de l'entreprise identifié par le code alpha-3 du standard ISO 3166-1. Oui
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non
monitoredSupplier Boolean True si fournisseur suivi, false sinon. Un fournisseur est suivi dès lors qu'il a au moins un dossier actif. Oui
name String Dénomination sociale. Oui
addressStreet String Adresse – Rue. Non
addressCity String Adresse – Ville. Non
addressPostCode String Adresse – Code postal. Non
addressCountryCode String Adresse – Pays. Non
supplierUsers List<UserInformation> Informations des utilisateurs du compte fournisseur. Non
subscriptionState Boolean État d'inscription du compte fournisseur, inscrit (true) ou non inscrit (false). Oui
subscriptionDate Date Date d'inscription du compte fournisseur. Non
subscriptionKey String Clé d'inscription. Elle est demandée au fournisseur au moment de son adhésion. Elle doit lui être communiquée lors de relance d'inscription. Oui
outOfBusiness Boolean True si l'établissement est fermé, false si actif. Oui

UserInformation

Attributs Type Description NULL
firstName String Prénom de l'utilisateur. Oui
lastName String Nom de l'utilisateur. Oui
email String Email de l'utilisateur. Oui
internationalPhone String Numéro de téléphone de l'utilisateur au format international. Oui

getGlobalInformation

Cette méthode permet de restituer les statistiques globales du compte donneur d'ordre. Les statistiques concernent uniquement les fournisseurs actuellement suivis.

Elle n'accepte pas de parametre dans la requête.

Exemple de requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:srv="http://srv.v3.ws.ea.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <srv:getGlobalInformation/>
   </soapenv:Body>
</soapenv:Envelope>

Exemple de réponse SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:getGlobalInformationResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <listIndicatorsStatistics>
               <indicatorCode>I001</indicatorCode>
               <numberOfCompleteDossier>244</numberOfCompleteDossier>
               <numberOfCompleteSupplier>153</numberOfCompleteSupplier>
               <numberOfDossier>447</numberOfDossier>
               <numberOfSupplier>316</numberOfSupplier>
               <numberOfSubscribedSupplier>252</numberOfSubscribedSupplier>
            </listIndicatorsStatistics>
            <numberOfCompleteDossier>222</numberOfCompleteDossier>
            <numberOfCompleteSupplier>139</numberOfCompleteSupplier>
            <numberOfDossier>448</numberOfDossier>
            <numberOfSupplier>317</numberOfSupplier>
            <numberOfSubscribedSupplier>252</numberOfSubscribedSupplier>
         </return>
      </ns1:getGlobalInformationResponse>
   </soap:Body>
</soap:Envelope>

Response

Attributs Type Description NULL
numberOfSupplier Integer Nombre de fournisseurs suivis. Oui
numberOfSubscribedSupplier Integer Nombre de fournisseurs inscrits (avec des utilisateurs). Oui
numberOfCompleteSupplier Integer Nombre de fournisseur ayant l'ensemble de leurs dossiers complets. Oui
numberOfDossier Integer Nombre de dossiers actifs. Oui
numberOfCompleteDossier Integer Nombre de dossiers complets. Oui
listIndicatorsStatistics List<IndicatorStatistics> Informations des utilisateurs du compte fournisseur. Non

IndicatorStatistics

Attributs Type Description NULL
indicatorCode String Code de l'indicateur (cf 3.3 Codes d'indicateur). Oui
numberOfSupplier Integer Nombre de fournisseurs suivis pour cet indicateur. Oui
numberOfSubscribedSupplier Integer Nombre de fournisseurs inscrits (avec des utilisateurs) pour cet indicateur. Oui
numberOfCompleteSupplier Integer Nombre de fournisseur ayant l'ensemble de leurs dossiers complets pour cet indicateur. Oui
numberOfDossier Integer Nombre de dossiers actifs pour cet indicateur. Oui
numberOfCompleteDossier Integer Nombre de dossiers complets pour cet indicateur. Oui

getAvailableDocuments

Cette méthode retourne l'ensemble des types de documents configuré pour le compte donneur d'ordre :

Pour modifier ces listes, il faut contacter e-Attestations afin de mettre à jour les paramètres du compte.

Exemple de requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:srv="http://srv.v3.ws.ea.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <srv:getAvailableDocuments/>
   </soapenv:Body>
</soapenv:Envelope>

Exemple de réponse SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:getAvailableDocumentsResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <availableDocuments>
               <documentCode>ASSUR_RCPRO</documentCode>
               <name>Attestation d’assurance RC Pro</name>
            </availableDocuments>
            <availableDocuments>
               <documentCode>ASSUR_DECENNALE</documentCode>
               <name>Attestation d’assurance décennale</name>
            </availableDocuments>
            <availableDocuments>
               <documentCode>JUSTIF_IMM</documentCode>
               <name>Justificatif d’immatriculation</name>
            </availableDocuments>
            <availableDocuments>
               <documentCode>LST_SAL_ETR</documentCode>
               <name>Déclaration des salariés</name>
            </availableDocuments>
            <availableDocuments>
               <documentCode>ATT_MARCHE_PUBLIC</documentCode>
               <name>Attestation de marché public</name>
            </availableDocuments>
            <availableDocuments>
               <documentCode>ATT_VIGI</documentCode>
               <name>Attestation de vigilance (6 mois)</name>
            </availableDocuments>
            <defaultDocuments>
               <documentCode>JUSTIF_IMM</documentCode>
               <name>Justificatif d’immatriculation</name>
            </defaultDocuments>
            <defaultDocuments>
               <documentCode>LST_SAL_ETR</documentCode>
               <name>Déclaration des salariés</name>
            </defaultDocuments>
            <defaultDocuments>
               <documentCode>ATT_VIGI</documentCode>
               <name>Attestation de vigilance (6 mois)</name>
            </defaultDocuments>
         </return>
      </ns1:getAvailableDocumentsResponse>
   </soap:Body>
</soap:Envelope>

Response

Attributs Type Description NULL
availableDocuments List<DocumentInformation> Liste des documents autorisés. Non
defaultDocuments List<DocumentInformation> Liste des documents demandés par défaut. Non

DocumentInformation

Attributs Type Description NULL
documentCode String Code qui identifie le document. Il est unique et non modifiable. Oui
name String Nom du document. Il peut évoluer avec le temps. Oui

updateDossier

Cette méthode permet de mettre à jour les informations d'un dossier actif.

Exemple de requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:srv="http://srv.v3.ws.ea.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <srv:updateDossier>
         <dossierUpdate>
            <dataToUpdate>
               <newDescription>This is my updated description</newDescription>
               <newDossierReference>NEW_REF_001</newDossierReference>
               <newExpirationDate>2016-12-31</newExpirationDate>
               <!--<newPurchasingCategory></newPurchasingCategory>-->
               <!--<newSupplierCode></newSupplierCode>-->
||  <!--<newSupplierEmail></newSupplierEmail>-->
            </dataToUpdate>
            <dossierReference>REF_001</dossierReference>
            <supplierSearch>
               <!--<companyIDType></companyIDType>-->
               <!--<companyIDValue></companyIDValue>-->
               <supplierCode>SC_001</supplierCode>
            </supplierSearch>
         </dossierUpdate>
      </srv:updateDossier>
   </soapenv:Body>
</soapenv:Envelope>

Exemple de réponse SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:updateDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <complete>true</complete>
            <success>true</success>
         </return>
      </ns1:updateDossierResponse>
   </soap:Body>
</soap:Envelope>

Exemple de réponse FAIL

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:updateDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <complete>true</complete>
            <listErrors>
               <code>E200</code>
            </listErrors>
            <listErrors>
               <additional>NEW_REF_001</additional>
               <code>E202</code>
            </listErrors>
            <success>false</success>
         </return>
      </ns1:updateDossierResponse>
   </soap:Body>

DossierUpdate

Attributs Type Description NULL
supplierSearch SupplierSearch Informations pour identifier le fournisseur du dossier à mettre à jour. Oui
dossierReference String Référence du dossier à mettre à jour. Oui
dataToUpdate DataToUpdate Objet contenant les informations à modifier. Oui

SupplierSearch

Attributs Type Description NULL
companyIDType String Type d'identifiant de l'entreprise (Codes d'identification d'une entreprise). Non*
companyIDValue String Valeur de l'identifiant de l'entreprise. Non*
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non*

DataToUpdate

Attributs Type Description NULL
newDescription String Nouvelle description du dossier. Non*
newDossierReference String "Nouvelle référence du dossier.Elle ne peut pas être vide. L'espace dans le référence est supprime puis il va être convertir en majuscule." Non*
newExpirationDate Date Nouvelle date d'expiration du dossier. Non*
nilExpirationDate Boolean Positionne la date d'expiration à pas de date d'expiration lorsque la valeur est True. Cet attribut est prioritaire sur newExpirationDate. Non*
newPurchasingCategory String Nouvelle catégorie achat du dossier. Non*
newSupplierCode String Nouveau code fournisseur du fournisseur du dossier. Non*
newSupplierEmail String Invitation d'un correspondant fournisseur. Cette action envoi immédiatement un e-mail d'invitation. Non*

stopDossier

Cette méthode permet d'arrêter la surveillance d'un ou plusieurs dossiers actifs.

Il est possible de désactiver :

Exemple de requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:srv="http://srv.v3.ws.ea.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <srv:stopDossier>
         <dossierStop>
            <dossierReference>NEW_REF_001</dossierReference>
          <supplierSearch>
               <companyIDType>CIT001</companyIDType>
               <companyIDValue>50382936800037</companyIDValue>
              <supplierCode></supplierCode>
            </supplierSearch>
         </dossierStop>
      </srv:stopDossier>
   </soapenv:Body>
</soapenv:Envelope>

Exemple de réponse SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:stopDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <complete>true</complete>
            <success>true</success>
         </return>
      </ns1:stopDossierResponse>
   </soap:Body>
</soap:Envelope>

Exemple de réponse FAIL

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:stopDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <complete>true</complete>
            <listErrors>
               <additional>REF_001</additional>
               <code>E201</code>
            </listErrors>
            <success>false</success>
         </return>
      </ns1:stopDossierResponse>
   </soap:Body></soap:Envelope>

DossierStop

Attributs Type Description NULL
supplierSearch SupplierSearch Informations pour identifier le fournisseur du dossier à désactiver. Oui
dossierReference String Référence du dossier à désactiver. Non

SupplierSearch

Attributs Type Description NULL
companyIDType String Type d'identifiant de l'entreprise (Codes d'identification d'une entreprise). Non*
companyIDValue String Valeur de l'identifiant de l'entreprise. Non*
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non*

DataToUpdate

Attributs Type Description NULL
newDescription String Nouvelle description du dossier. Non*
newDossierReference String "Nouvelle référence du dossier.Elle ne peut pas être vide. L'espace dans le référence est supprime puis il va être convertir en majuscule." Non*
newExpirationDate Date Nouvelle date d'expiration du dossier. Non*
nilExpirationDate Boolean Positionne la date d'expiration à pas de date d'expiration lorsque la valeur est True. Cet attribut est prioritaire sur newExpirationDate. Non*
newPurchasingCategory String Nouvelle catégorie achat du dossier. Non*
newSupplierCode String Nouveau code fournisseur du fournisseur du dossier. Non*
newSupplierEmail String Invitation d'un correspondant fournisseur. Cette action envoi immédiatement un e-mail d'invitation. Non*

updateRequiredDocuments

Cette méthode permet de mettre à jour les documents demandés pour un dossier actif.

La liste des documents renseignée remplace les précédentes demandes.

Les documents demandés doivent avoir été préalablement configurés sur le compte.

Exemple de requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:srv="http://srv.v3.ws.ea.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <srv:updateRequiredDocuments>
         <requiredDocumentsUpdate>
            <dossierReference>NEW_REF_001</dossierReference>
            <!-- Documents actuellement demandés-->
            <newRequiredDocuments>ATT_VIGI</newRequiredDocuments>
            <newRequiredDocuments>JUSTIF_IMM</newRequiredDocuments>
            <newRequiredDocuments>ASSUR_RCPRO</newRequiredDocuments>
            <!-- Nouveaux documents à demander -->
            <newRequiredDocuments>ATT_MARCHE_PUBLIC</newRequiredDocuments>
            <newRequiredDocuments>LST_SAL_ETR</newRequiredDocuments>
            <supplierSearch>
               <companyIDType>CIT001</companyIDType>
               <companyIDValue>50382936800037</companyIDValue>
               <!--<supplierCode></supplierCode>-->
            </supplierSearch>
         </requiredDocumentsUpdate>
      </srv:updateRequiredDocuments>
   </soapenv:Body>
</soapenv:Envelope>

Exemple de réponse SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:updateRequiredDocumentsResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <complete>true</complete>
            <success>true</success>
         </return>
      </ns1:updateRequiredDocumentsResponse>
   </soap:Body>
</soap:Envelope>

Exemple de réponse FAIL

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:updateRequiredDocumentsResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <complete>true</complete>
            <listErrors>
               <additional>NEW_REF_001</additional>
               <code>E201</code>
            </listErrors>
            <success>false</success>
         </return>
      </ns1:updateRequiredDocumentsResponse>
   </soap:Body>
</soap:Envelope>

RequiredDocumentsUpdate

Attributs Type Description NULL
supplierSearch SupplierSearch Informations pour identifier le fournisseur concerné. Oui
dossierReference String Référence du dossier concerné. Oui
newRequiredDocuments List "Liste des codes de documents à demander. Remplace les demandes précédentes.
Les codes disponibles sont restitués par la Méthode : getAvailableDocuments." Non

SupplierSearch

Attributs Type Description NULL
companyIDType String Type d'identifiant de l'entreprise (Codes d'identification d'une entreprise). Non*
companyIDValue String Valeur de l'identifiant de l'entreprise. Non*
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non*

DataToUpdate

Attributs Type Description NULL
newDescription String Nouvelle description du dossier. Non*
newDossierReference String "Nouvelle référence du dossier.Elle ne peut pas être vide. L'espace dans le référence est supprime puis il va être convertir en majuscule." Non*
newExpirationDate Date Nouvelle date d'expiration du dossier. Non*
nilExpirationDate Boolean Positionne la date d'expiration à pas de date d'expiration lorsque la valeur est True. Cet attribut est prioritaire sur newExpirationDate. Non*
newPurchasingCategory String Nouvelle catégorie achat du dossier. Non*
newSupplierCode String Nouveau code fournisseur du fournisseur du dossier. Non*
newSupplierEmail String Invitation d'un correspondant fournisseur. Cette action envoi immédiatement un e-mail d'invitation. Non*

reactivateDossier

Cette méthode permet de réactiver un dossier.

Exemple de requête

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:srv="http://srv.v3.ws.ea.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <srv:reActivateDossier>
         <dossierReActivate>   
            <dossierReference>SUP008183</dossierReference>
            <supplierSearch>        
               <companyIDType>CIT001</companyIDType>           
               <companyIDValue>50879531700017</companyIDValue>             
            </supplierSearch>
         </dossierReActivate>
      </srv:reActivateDossier>
   </soapenv:Body>
</soapenv:Envelope>

Exemple de réponse SUCCESS

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:reActivateDossierResponse xmlns:ns1="http://srv.v3.ws.ea.com/">
         <return xmlns:ns2="http://srv.v3.ws.ea.com/">
            <complete>true</complete>
            <success>true</success>
         </return>
      </ns1:reActivateDossierResponse>
   </soap:Body>
</soap:Envelope>

DossierReactivate

Attributs Type Description NULL
supplierSearch SupplierSearch Informations pour identifier le fournisseur du dossier à désactiver. Oui
dossierReference String Référence du dossier à désactiver. Non
expirationDate Date "Date d'expiration du dossier à ré-activer. Si aucune valeur mentionné le date d'expiration reste celle d'avant la désactivation. La date d'expiration doit être dans le futur." Non
nilExpirationDate Boolean Positionne la date d'expiration à pas de date d'expiration lorsque la valeur est True. Cet attribut est prioritaire sur expirationDate. Non

SupplierSearch

Attributs Type Description NULL
companyIDType String Type d'identifiant de l'entreprise (Codes d'identification d'une entreprise). Non*
companyIDValue String Valeur de l'identifiant de l'entreprise. Non*
supplierCode String Code fournisseur pour identifier le fournisseur (identifiant interne client). Non*

DataToUpdate

Attributs Type Description NULL
newDescription String Nouvelle description du dossier. Non*
newDossierReference String "Nouvelle référence du dossier.Elle ne peut pas être vide. L'espace dans le référence est supprime puis il va être convertir en majuscule." Non*
newExpirationDate Date Nouvelle date d'expiration du dossier. Non*
nilExpirationDate Boolean Positionne la date d'expiration à pas de date d'expiration lorsque la valeur est True. Cet attribut est prioritaire sur newExpirationDate. Non*
newPurchasingCategory String Nouvelle catégorie achat du dossier. Non*
newSupplierCode String Nouveau code fournisseur du fournisseur du dossier. Non*
newSupplierEmail String Invitation d'un correspondant fournisseur. Cette action envoi immédiatement un e-mail d'invitation. Non*

Nomenclature

Codes d'identification d'une entreprise

CompanyIDType Description CompanyIDValue
CIT001 SIRET : identifiant utilisé en France pour qualifier les établissements. Nombre de 14 chiffres qui vérifie l'algorithme de Luhn.
CIT002 Numéro TVA : identifiant utilisé par la CEE pour les entreprises soumis à l'impôt sur les sociétés. https://en.wikipedia.org/wiki/VAT_identification_number
CIT003 Indentifiant Dun & Bradstreet (DUNS) : identifiant unique de la plus grande base de données de référencement de tiers internationaux au monde. https://www.dnb.com/ca-fr/duns-number.html

Codes d'indicateur

Code Nom Description
I001 Travail dissimulé Complétude des documents demandés *

Codes d'erreur et signification

Les codes d'erreur sont renvoyé sans message afin que l'intégration de l'interprétation de ces erreurs restent libres.

La liste des codes d'erreurs présentée dans cette section est relative aux erreurs dites génériques.

Structure

Attributs Type Description NOT NULL
code String Code de l'erreur YES
additional String Liste des erreurs. NO

HTTP Error Codes

Error Code Meaning
400 Bad Request -- Votre requête est invalide au niveau protocolaire (protocole SOAP)
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- L'accès n'est pas autorisé. Soit que vos identifiants sont incorrects soit que le 'client' a une IP qui n'est pas reconnue que de confiance par eAttestratsion
418 I'm a teapot.
500 Internal Server Error -- Le serveur a rencontrer une erreure grave et n'a pu répondre à la requête
503 Service Unavailable -- Le service n'est pas disponible

Codes d'erreurs communs

Code Description Additional
E001 Paramètre manquant Nom du paramètre
E002 Paramètre inconnu Nom du paramètre/Valeur
E003 Paramètre vide Nom du paramètre
E010 Format incorrect Nom du paramètre/Valeur
E011 Taille maximale dépassée. Nom du paramètre/Taille max
E021 Date dans le passé (newExpirationDate) Nom du paramètre
E022 Date dans le futur Nom du paramètre
E030 Domaine de l’e-mail invalide Valeur du paramètre

Codes d'erreurs par entité interrogée

Tiers/Fournisseurs

Code Description Additional
E100 Erreur lors de la qualification de l'établissement.
Aucun tiers/fournisseur ne correspond aux critères de la recherche
E101 Erreur lors de la qualification de l'établissement.
E102 L'établissement n'existe pas Identifiant de l'établissement*
E103 L'établissement est fermé Identifiant de l'établissement*
E104 Plusieurs fournisseurs correspondent à la recherche Identifiant de l'établissement*
E111 Le code fournisseur (supplierCode) est différent de celui déjà existant supplierCode existant
E112 Le code fournisseur (supplierCode ou newSupplierCode) est déjà utilisé pour un autre fournisseur Identifiant de l'autre fournisseur*
E113 Le compte du fournisseur est désactivé
E121 Impossible d'importer un fournisseur français avec la TVA Identifiant de l'établissement*
E122 Impossible d'importer un fournisseur étranger. L'option fournisseur étranger n'est pas activée

Dossiers

Code Description Additional
E200 Aucun dossier ne correspond à la recherche
E201 Le dossier est désactivé Reference du dossier
E202 La référence existe déjà pour ce fournisseur Reference du dossier
E203 Aucun dossier existe avec ce référence. (newDossierReference) Reference du dossier
E204 Le dossier est déjà actif Reference du dossier
E205 Le dossier à réactiver a une date d'expiration dans le passée. Modifier cette date (dateExpiration) Date d'expiration

Documents demandés

Code Description Additional
E301 Le document est désactivé. Il ne peut plus être demandé. Contactez e-Attestations pour plus d'informations. Code du document
E302 Le document n'est pas autorisé. Il ne fait pas partie de la liste des documents que votre compte peut demander aux fournisseurs. Contactez votre gestionnaire de compte e-Attestations pour ajouter ce document à votre bibliothèque. Code du document
xml