Alma est en mesure de générer un certain nombre de rapports qui peut vous aider dans l'analyse de vos affaires réalisées avec nos services, et dans l'automatisation de cette analyse.

L'objet DataExport

Un objet Data Export représente un export de données d'un certain type, disponible en différents formats de fichiers, et éventuellement limité à une plage de date spécifique.

Attributs

Attribut

Type

Description

complete

Booléen

Indique si la génération de l'export est terminée ou non, celle-ci se faisant de façon asynchrone après la création de l'objet DataExport via l'API

created

Timestamp

Date/heure de création de l'export

start

Timestamp

Date/heure du début de la période prise en compte pour l'export

end

Timestamp

Date/heure de la fin de la période prise en compte pour l'export

id

String

Identifiant de l'export

type

String

Type d'export (voir ci-dessous)

updated

Timestamp

Date/heure de dernière modification de l'export

url_csv, url_pdf, url_xlsx

String

URLs des fichiers disponibles au téléchargement pour cet export.

Tous les formats ne sont pas disponibles pour tous les types d'exports : voir détails dans le tableau ci-dessous.

Ces URLs ne seront renseignées que pour les formats supportés par le type de l'export et une fois que l'attribut completed sera true.

🚧

Attributs non documentés

Tout attribut non documenté ci-dessus présent dans les données renvoyées par l'API doit être considéré comme privé/réservé, et susceptible de changer ou disparaître à tout moment.

Types d'exports

Les types d'exports possibles sont décrits dans la table ci-dessous :

Type

Description

Téléchargeable au format...

payments

Génère un extrait des ventes pour les dates données (si fournies), en incluant les colonnes correspondant aux custom_fields passés en paramètres le cas échéant.

  • CSV (via url_csv)
  • XLSX (via url_xlsx)

pos_export

Identique à l'export de type payments, en filtrant toutefois les ventes pour ne garder que celles effectuées en magasin (i.e. créées depuis Alma POS ou via l'API avec l'attribut origin autre que online)

  • CSV (via url_csv)
  • XLSX (via url_xlsx)

statement

Génère un relevé d'opérations, qui récapitule pour la période donnée :

  • Le total des ventes et des commissions afférentes
  • Le total des remboursements
  • Le total des montants virés sur votre compte bancaire
  • Le total des ajustements exceptionnels et gratuités de frais éventuels
  • PDF (via url_pdf)

accounting

L'équivalent "technique" du type statement.

Les exports comptables sont les exports les plus utilisés dans le cadre de la réconciliation comptable automatisée.
Ils vous permettent d'obtenir, pour une période données, le détail toutes les transactions qui ont eu lieu sur votre compte :

  • Ventes
  • Remboursements
  • Ajustements exceptionnels
  • Virements

L'export inclue pour chaque transaction les colonnes correspondant aux custom_fields passés en paramètres le cas échéant.

  • CSV (via url_csv)
  • XLSX (via url_xlsx)

accounting_for_payout

Export identique au type accounting, mais restreint aux seules transactions prises en compte dans le virement dont l'ID est passé en paramètre (payout).

Dans ce cas, les paramètres de date start et end n'ont par conséquent aucun effet.

  • CSV (via url_csv)
  • XLSX (via url_xlsx)

→ Les colonnes des exports au format CSV/XLSX sont décrites sur la page Exports comptables

Automatisation des exports de données

Via les API décrites dans cette section, il est possible de générer ces différents fichiers et d'en récupérer le contenu de façon entièrement automatisée :

Diagramme de séquence détaillant le process de génération et téléchargement d'un export de donnéesDiagramme de séquence détaillant le process de génération et téléchargement d'un export de données

Diagramme de séquence détaillant le process de génération et téléchargement d'un export de données

📘

Automatiser la génération et le téléchargement d'un export de données

Pour un guide détaillé sur la génération et le téléchargement d'exports de données, référez-vous au guide Générer des fichiers d'export comptable via l'API.