RecupererFichiersVirementChiffres
  • 23 Aug 2024
  • 3 Minutes à lire
  • Sombre
    Lumière
  • PDF

RecupererFichiersVirementChiffres

  • Sombre
    Lumière
  • PDF

Résumé de l’article

Fonction API

/v1/Paiements/RecupererFichiersVirementChiffres

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 et de renvoyer ces fichiers chiffrés.
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.
    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 lesquels 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.

Cette fonction API est opérationnelle lorsque la génération des fichiers de virements est bloquée :
Générer des fichiers de virements chiffrés via API

Groupe de fonctions API

PAIE002

Paramètres de la requête

ParamètreTypeDescription
proprietesChiffrementProprietesChiffrementÉlément structuré contenant les propriétés de chiffrement avec lesquelles les fichiers seront chiffrés (cf. Détail ci-dessous)
dateValeurstring(date-time)Date de valeur du virement
libelleVirementstringLibellé 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 :
  • 31 caractères pour la norme ETEBAC
  • 140 caractères pour la norme SEPA
Vous disposez de variables pour créer votre libellé :
  • %PERIODE : la période du bulletin correspondant au virement (ex: 01-2013)
  • %PERIODEL : la période du bulletin correspondant au virement en minuscules (ex: janvier 2013)
  • %PERIODELM : la période du bulletin correspondant au virement en majuscules (ex: JANVIER 2013)
  • %ETABLISSEMENT : la raison sociale de l'établissement sur lequel le bulletin a été fait
  • %MATRICULE : le matricule du salarié concerné par le virement
matriculeSalariesstring[]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
periodestring(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
numeroDossierstring

Numéro du dossier concerné par la requête

ProprietesChiffrement

ParamètreTypeDescription
clestringClé publique à utiliser pour le chiffrement. Ce paramètre accepte le format binaire encodé en base64 ou le format texte commençant par la ligne "-----BEGIN PGP PUBLIC KEY BLOCK-----"
algorithmeSymetriquestringAlgorithme symétrique qui sera utilisé par la fonction pour chiffrer le contenu des fichiers générés. Les valeurs possibles sont : AES128, AES192, AES256 (recommandé)

Paramètres de la réponse

ParamètreTypeDescription
bilanMatriculesBilanMatriculesÉ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
fichiersVirementsRecupererFichierVirementResult[]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ètreTypeDescription
matriculesInclusstring[]Liste des matricules pour lesquels les fichiers ont été générés
matriculesExclusstring[]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ètreTypeDescription
fichierstringNom du fichier
contenustring(byte)Fichiers chiffrés selon les paramètres de la requête et encodés en base64 :
2 fichiers au format PDF
1 fichier au format XML

Requête

{
  "proprietesChiffrement": {
    "cle": "string",
    "algorithmeSymetrique": "string"
  },
  "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

ErreurMessageDescription

Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.