Aller au contenu

Agrégats de factures

Récupération de la liste des agrégats de factures

GET /api/v1/invoice-aggregate/

Paramètres de requête

Nom Type Description Obligatoire
business_partner_code string Code partenaire commercial Non
generation_date_lt string Date de génération inférieure ou égale (format YYYY-MM-DD) Non
generation_date_gt string Date de génération supérieure ou égale (format YYYY-MM-DD) Non
aggregate_number string Numéro d'agrégat Non
line_number integer Numéro de ligne Non
cursor string Curseur pour la pagination Non
page_size integer Nombre d'éléments par page (défaut: 20) Non

Réponse

Nom Type Description
page_size integer Nombre d'éléments par page
count integer Nombre total d'éléments
next_page string URL de la page suivante
previous_page string URL de la page précédente
results array Liste des agrégats de factures

Détail d'un agrégat de factures

Nom Type Description
aggregate_number string Numéro de l'agrégat
generation_date string Date de génération
line_number integer Numéro de ligne
Exemple
{
  "page_size": 20,
  "count": 45,
  "next_page": "http://api.example.com/api/v1/invoice-aggregate/?cursor=2&page_size=20",
  "previous_page": null,
  "results": [
    {
      "aggregate_number": "AGR250731006",
      "generation_date": "2025-07-31",
      "line_number": 1
    },
    {
      "aggregate_number": "AGR250731007",
      "generation_date": "2025-07-31",
      "line_number": 2
    }
  ]
}

Téléchargement d'un agrégat de factures

GET /api/v1/invoice-aggregate/{aggregate_number}/{line_number}/download/

Paramètres de la requête

Nom Type Description Obligatoire
aggregate_number string Numéro de l'agrégat Oui
line_number integer Numéro de ligne Oui

Réponse

Le contenu du fichier CSV d'agrégat de factures au format binaire.

En-têtes de réponse

En-tête Valeur
Content-Type text/csv
Content-Disposition attachment; filename={aggregate_number}_{line_number}.csv

Gestion des erreurs

Code HTTP Description
200 Succès
401 Utilisateur non authentifié
403 Permission refusée
404 Agrégat de factures non trouvé
500 Erreur interne du serveur