Skip to main content
Les fichiers CODB sont les fichiers salariaux que les secrétariats sociaux transmettent à Codaclean pour vos clients. Le processus est le même que pour les fichiers CODA. Les fichiers arrivent le matin : il suffit de l’exécuter deux fois par jour.
1

Listez les nouveaux fichiers

Appelez POST /codb-files avec un corps JSON, au minimum {}.Par défaut, la réponse ne contient que les fichiers dont vous n’avez pas encore confirmé le téléchargement.Les fichiers sont regroupés par client, puis par secrétariat social et par année.Filtres utiles : enterpriseNumber, payrollProvider, accountPeriod, statementDate, processingDate, statementNumber.Passez includePdf à true pour recevoir aussi la version PDF de chaque fichier.Scope requis : files:read
2

Téléchargez chaque fichier

Chaque fichier comporte un lien urls.codb (ainsi qu’un lien urls.pdf, si vous l’avez demandé).Il s’agit d’URL présignées : téléchargez-les avec un simple GET, sans les en-têtes de l’API.
Les URL de téléchargement expirent 30 minutes après l’appel qui liste les fichiers.Si une URL a expiré, listez de nouveau les fichiers pour en obtenir une nouvelle.
3

Confirmez chaque téléchargement

Une fois le fichier enregistré de votre côté, appelez DELETE /codb-files/{fileId} avec l’id du fichier.Le fichier n’est pas supprimé. Il est marqué comme téléchargé pour votre clé API et l’utilisateur courant, et n’apparaît plus dans la liste suivante.Une seconde confirmation du même fichier renvoie 409.

Télécharger de nouveau un fichier

Pour lister les fichiers déjà confirmés, envoyez "redownload": true.

Bon à savoir

  • Dans les réponses CODB, statementDate correspond à la date de génération du fichier, et statementNumber à son numéro de séquence.
  • statementNumber est une chaîne de caractères. Elle est généralement numérique, mais peut combiner plusieurs numéros de séquence (par exemple "0103-0203") : ne la convertissez pas en nombre.
  • accountPeriod est un entier au format AAAAMM (par exemple 202609).
  • La liste n’est pas paginée. Confirmez les fichiers au fur et à mesure pour garder des réponses légères.
  • Les confirmations sont propres à chaque clé API et à chaque utilisateur.