SalariesBulletins
  • 03 Sep 2024
  • 1 Minute à lire
  • Sombre
    Lumière
  • PDF

SalariesBulletins

  • Sombre
    Lumière
  • PDF

Résumé de l’article

Fonction API

/v1/InfosSalaries/SalariesBulletins

Verbe HTTP

Post

Description

Permet de récupérer les ID des images des bulletins de salariés, avec quelques informations complémentaires (comme la présence ou non d'attestation Pôle Emploi).
Cette même fonction est proposée en mode asynchrone : SalariesBulletinsAsynchrone

Groupe de fonctions API

DATA001

Paramètres de la requête

ParamètreTypeDescription
requeteSalariesBulletinsRequeteSalariesBulletinsÉlément structuré contenant les critères de recherche des bulletins à remonter (cf. détail ci-dessous)
nomInterneEtablissementstringFiltre optionnel d'établissement
numeroDossierstring

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

RequeteSalariesBulletins

ParamètreTypeDescription
matriculeSalariestringMatricule du salarié concerné. Si ce paramètre est vide, la recherche se fera sur tous les salariés
identifiantEmploiinteger(int32)Identifiant de l'emploi pour lequel on recherche des bulletins. la valeur 0 permet de rechercher sur tous les emplois du salarié
periodeDebutstring(date-time)Date de début de la période sur laquelle rechercher des bulletins
periodeFinstring(date-time)Date de fin de la période sur laquelle rechercher des bulletins
bulletinsOriginauxSeulementbooleanPermet d'indiquer si on recherche uniquement les bulletins orignaux (true) ou non (false)

Paramètres de la réponse

ParamètreTypeDescription
salariesBulletinsSalarieBulletinsResult[]Liste d'éléments structurés contenant les informations des bulletins identifiés pour chaque période de paie (cf. détail ci-dessous)

SalarieBulletinsResult

ParamètreTypeDescription
matriculeSalariestringMatricule du salarié
periodestring(date-time)Période de paie des bulletins trouvés
arr_ID_PAIBULLETINinteger[]Liste des ID des images des bulletins trouvés. Cet ID pourra être utilisé pour récupérer l'image PDF du bulletin via la fonction RecupererImage
arr_PresenceAttestationPoleEmploiboolean[]Indique pour chaque bulletin s'il y a une attestation Pôle Emploi rattachée (true) ou non (false). Pour faire la correspondance, l'indice du tableau de booléen correspond à l'indice du tableau d'int du paramètre arr_ID_PAIBULLETIN

Requête

{
  "requeteSalariesBulletins": {
    "matriculeSalarie": "string",
    "identifiantEmploi": 0,
    "periodeDebut": "2020-10-14T21:46:24",
    "periodeFin": "2020-10-14T21:46:24",
    "bulletinsOriginauxSeulement": true
  },
  "nomInterneEtablissement": "string",
  "numeroDossier": "string"
}

Réponse

{
  "salariesBulletins": [
    {
      "matriculeSalarie": "string",
      "periode": "2020-10-14T21:46:24",
      "arr_ID_PAIBULLETIN": [
        0,
        0
      ],
      "arr_PresenceAttestationPoleEmploi": [
        true,
        true
      ]
    },
    {
      "matriculeSalarie": "string",
      "periode": "2020-10-14T21:46:24",
      "arr_ID_PAIBULLETIN": [
        0,
        0
      ],
      "arr_PresenceAttestationPoleEmploi": [
        true,
        true
      ]
    }
  ]
}

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.