- 12 Feb 2023
- 2 Minutes à lire
- Impression
- SombreLumière
- PDF
SWS_RecupererFichiersVirementHorsBulletin
- Mis à jour le 12 Feb 2023
- 2 Minutes à lire
- Impression
- SombreLumière
- PDF
Fonction API
SWS_RecupererFichiersVirementHorsBulletin
Description
Permet de générer les fichiers de virements pour les salariés identifiés en paramètre de la requête.
Il est possible que des virements aient déjà été réalisés sur la période. Dans ce cas la méthode ne va utiliser que les matricules pour lesquel il est possible de générer des virements. Ces matricules seront contenus dans la propriété MatriculesInclus. Tous les matricules non inclus dans les fichiers de virements seront contenus dans la propriété MatriculeExclus.
Groupe de fonctions API
Code API : N10 / PAI001
Paramètres de la requête
Paramètre | Type | Description |
---|---|---|
Token | string | Token d'authentification renvoyé en réponse à l'authentification via SWS_SiteLogin |
NumeroDossier | string | Numéro du dossier concerné par la requête |
MatriculeSalaries | string[] | Liste des matricules salariés à prendre en compte |
PeriodeDebut | dateTime | Période de début de génération des fichiers de virements. Ce paramètre est obligatoire |
PeriodeFin | dateTime | Période de fin de génération des fichiers de virements. Ce paramètre est obligatoire |
LibelleVirement | string | Libellé du virement. Ce paramètre peut être vide. Dans ce cas la fonction utilise le libellé de la précédente génération des fichiers de virements. Complément sur LibelleVirement La longueur du libellé pour les virements est de :
|
Paramètres de la réponse
Paramètre | Type | Description |
---|---|---|
SWS_RecupererFichiersVirementHorsBulletinResult | SWS_RecupererFichiersVirementsResult | Élément structuré contenant la réponse à la requête (Détail ci-dessous) |
SWS_RecupererFichiersVirementsResult
Paramètre | Type | Description |
---|---|---|
Error | string | Vide s'il n'y a pas d'erreur, sinon contient la description de l'erreur rencontrée |
Arr_FichiersVirements | CPAISWSReponseRecupererFichierVirement[] | Liste d'éléments structurés contenant les fichiers générés (cf. détail ci-dessous). Alimenté si la requête a été exécutée avec succès |
BilanMatricules | BilanMatricules | Élément structuré contenant les informations des matricules pour lesquels les fichiers ont été générés (cf. détail ci-dessous). Alimenté si la requête a été exécutée avec succès |
CPAISWSReponseRecupererFichierVirement
Paramètre | Type | Description |
---|---|---|
Fichier | string | Nom du fichier |
Contenu | base64Binary | Fichier encodé en base64 |
BilanMatricules
Paramètre | Type | Description |
---|---|---|
MatriculesInclus | string[] | Liste des matricules pour lesquels les fichiers ont été générés |
MatriculesExclus | string[] | Liste des matricules pour lesquels les fichiers n'ont pas été généres (par exemple si le fichier de virement a déjà été généré pour ces salariés) |
Requête
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SWS_RecupererFichiersVirementHorsBulletin xmlns="http://www.silae.fr/">
<Token>string</Token>
<NumeroDossier>string</NumeroDossier>
<MatriculeSalaries>
<string>string</string>
<string>string</string>
</MatriculeSalaries>
<PeriodeDebut>yyyy-mm-ddThh:mm:ss</PeriodeDebut>
<PeriodeFin>yyyy-mm-ddThh:mm:ss</PeriodeFin>
<LibelleVirement>string</LibelleVirement>
</SWS_RecupererFichiersVirementHorsBulletin>
</soap12:Body>
</soap12:Envelope>
Réponse
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SWS_RecupererFichiersVirementHorsBulletinResponse xmlns="http://www.silae.fr/">
<SWS_RecupererFichiersVirementHorsBulletinResult>
<Error>string</Error>
<Arr_FichiersVirements>
<CPAISWSReponseRecupererFichierVirement>
<Fichier>string</Fichier>
<Contenu>base64Binary</Contenu>
</CPAISWSReponseRecupererFichierVirement>
<CPAISWSReponseRecupererFichierVirement>
<Fichier>string</Fichier>
<Contenu>base64Binary</Contenu>
</CPAISWSReponseRecupererFichierVirement>
</Arr_FichiersVirements>
<BilanMatricules>
<MatriculesInclus>
<string>string</string>
<string>string</string>
</MatriculesInclus>
<MatriculesExclus>
<string>string</string>
<string>string</string>
</MatriculesExclus>
</BilanMatricules>
</SWS_RecupererFichiersVirementHorsBulletinResult>
</SWS_RecupererFichiersVirementHorsBulletinResponse>
</soap12:Body>
</soap12:Envelope>