RecupererFichiersVirement
- 23 Aug 2024
- 2 Minutes à lire
- Impression
- SombreLumière
- PDF
RecupererFichiersVirement
- Mis à jour le 23 Aug 2024
- 2 Minutes à lire
- Impression
- SombreLumière
- PDF
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
Fonction API
/v1/Paiements/RecupererFichiersVirement
Verbe HTTP
Post
Description
Permet de générer les fichiers de virements pour les salariés identifiés en paramètre de la requête.
Plusieurs fichiers sont générés via l'appel à cette fonction :
- Le fichier de virement pour les salariés concernés.
- Les fichiers qui correspondent aux états de paiement qui accompagnent les fichiers de virement lors de la génération.
Dans le cas où les virements ont été déjà réalisés sur la période, seuls les salariés pour lesquels un virement est réalisable sont pris en compte. 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.
Cette fonction API est opérationnelle lorsque la génération des fichiers de virements n'est pas bloquée :
Générer des fichiers de virements chiffrés via API
Groupe de fonctions API
PAIE001
Paramètres de la requête
| Paramètre | Type | Description |
|---|---|---|
| dateValeur | string(date-time) | Date de valeur du virement |
| 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 :
|
| matriculeSalaries | string[] | Liste des matricules des salariés à inclure dans les fichiers de virements. Cette liste peut être vide. La fonction utilisera alors tous les salariés ayant un bulletin sur la période |
| periode | string(date) | Période de génération des fichiers de virements. Ce paramètre est obligatoire. La date doit être au format AAAA-MM-JJ |
| numeroDossier | string | Numéro du dossier concerné par la requête |
Paramètres de la réponse
| Paramètre | Type | Description |
|---|---|---|
| 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 |
| fichiersVirements | RecupererFichierVirementResult[] | 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
| 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) |
RecupererFichierVirementResult
| Paramètre | Type | Description |
|---|---|---|
| fichier | string | Nom du fichier |
| contenu | string(byte) | Fichiers encodés en base 64 : 2 fichiers au format PDF 1 fichier au format XML |
Requête
{
"dateValeur": "2020-10-14T21:46:24",
"libelleVirement": "string",
"matriculeSalaries": [
"string",
"string"
],
"periode": "2020-10-14",
"numeroDossier": "string"
}
Réponse
{
"bilanMatricules": {
"matriculesInclus": [
"string",
"string"
],
"matriculesExclus": [
"string",
"string"
]
},
"fichiersVirements": [
{
"fichier": "string",
"contenu": "VW4gZXhlbXBsZSBpbGx1c3RyYW50IGxlIHR5cGUgc3RyaW5nKGJ5dGUpLg=="
},
{
"fichier": "string",
"contenu": "VW4gZXhlbXBsZSBpbGx1c3RyYW50IGxlIHR5cGUgc3RyaW5nKGJ5dGUpLg=="
}
]
}
Messages d'erreur
| Erreur | Message | Description |
|---|---|---|
| Error | "Impossible de récupérer des fichiers de virements non-chiffrés lorsque le chiffrement est activé" | L'option Bloquer la génération des fichiers de virements a été activée sur le dossier de paie (cf. Générer des fichiers de virements chiffrés via API |
Cet article vous a-t-il été utile ?