EditionEtatDesPaiementsAsynchrone
- 12 Nov 2024
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
EditionEtatDesPaiementsAsynchrone
- Mis à jour le 12 Nov 2024
- 1 Minute à lire
- Impression
- SombreLumière
- PDF
Résumé de l’article
Avez-vous trouvé ce résumé utile ?
Merci pour vos commentaires
Fonction API
/v1/EditionEtatsPaie/EditionEtatDesPaiementsAsynchrone
Verbe HTTP
Post
Description
Cette fonction est identique à EditionEtatDesPaiements, à la différence que le traitement est asynchrone. Cela signifie que cette fonction lance le traitement et génère un identifiant de la tâche utile pour interroger le statut et obtenir le résultat grâce à la fonction associée StatutEditionEtatDesPaiementsAsynchrone
Groupe de fonctions API
CYCLE02
Paramètres de la requête
| Paramètre | Type | Description |
|---|---|---|
| format | string | - "pdf" : édition générée au format PDF - "excel" : édition générée au format EXCEL - Par défaut PDF : supprimer ce paramètre de la requête |
| periodeDebut | string(date-time) | Date de début de la période pour laquelle générer l'édition |
| periodeFin | string(date-time) | Date de fin de la période pour laquelle générer l'édition |
| numeroDossier | string | Numéro du dossier concerné par la requête |
Paramètres de la réponse
| Paramètre | Type | Description |
|---|---|---|
| guidTache | string | Identifiant de tâche de calcul à utiliser dans la fonction StatutEtatDesPaiementsAsynchrone pour obtenir le résultat |
Requête
{
"format": "string",
"periodeDebut": "2020-10-14T21:46:24",
"periodeFin": "2020-10-14T21:46:24",
"numeroDossier": "string"
}
Réponse
{
"guidTache": "string"
}
Messages d'erreur
| Erreur | Message | Description |
|---|---|---|
| 1000 | "Error converting value "" to type 'SILAE.PaieRestApi.Controllers.v1. EditionEtatsPaie.Models.TypeExportEdition. Path 'format', line x, position y." | Le format du fichier d'export n'est pas renseigné. Valeur acceptée : pdf ou excel. Valeur par défaut : format PDF, supprimer le paramètre de la requête |
Cet article vous a-t-il été utile ?