🌐 Documentation de l’intégration par FTP
📖 Pour réaliser une intégration d’un outil partenaire vers Fygr “via FTP”, le client doit déposer à intervalle régulier sur nos serveurs des fichiers avec un format spécifique. Nous recommandons un dépôt tous les jours, vers 20h (heure française). En amont de l’intégration, nous fournissons au client des identifiants “SFTP” afin de sécuriser le transfert des données.
Fichiers à préparer par le client
Format des fichiers
Format txt ou csv
Encoding: UTF-8
Séparateur : ;
En-tête / header : Oui , le nom des champs documentés ci-après
Nommage des fichiers
🧾 Receivable / 411 / Echéances clients : les fichiers doivent être nommés : receivable_%Y%m%d_%H%M%S .
Exemple : un export d’échéances clients généré le 14 juillet 2025 à 14:33:23 (UTC) doit être nommé receivable_20250714_143323
🧾 Payable / 401 / Echéances fournisseurs : les fichiers doivent être nommés : payable_%Y%m%d_%H%M%S
Exemple : un export d’échéances fournisseurs généré le 14 juillet 2025 à 14:33:23 (UTC) doit être nommé payable_20250714_143323
📖 Selon votre cas d’usage, vous pouvez déposer des fichiers receivable , payable , ou bien les deux. Nous recommandons d’utiliser une unique date pour l’ensemble des fichiers d’un même envoi.
Champs à renseigner
Nom de la colonne | Format | Obligatoire | Commentaire |
id | Char(100) | Oui | Identifiant technique de la facture dans l’outil partenaire. Il doit être unique pour chaque facture. |
invoice_number | Char(100) | Oui | Numéro de la facture |
issue_date | %Y-%m- %d | Oui | Date d’émission de la facture (ex : 2025-07-03 , et non 20250703 ou 03/07/2025 ) |
due_date | %Y-%m- %d | Oui | Date d’échéance |
expected_payment_date | %Y-%m- %d | Recommandé | = due_date si non renseigné |
amount | Float | Recommandé | Montant HT (ex : 1103.12 , et non 1 103,12€ ) |
tax_amount | Float | Recommandé | Montant TVA |
total_amount | Float | Oui | Montant TTC |
currency_iso | Char(3) | Oui | Ex : EUR pour l’€, USD pour le $ |
outstanding_amount | Float | Oui | Montant restant dû (reste à payer) |
status | StatusEnum | Oui | Les valeurs suivantes sont disponibles : paid
ongoing (en cours, en retard, partiellement payée)
cancelled → facture annulée, plus de paiement attendu.
deleted → supprimée, cas marginal |
description | Char(500) | Recommandé | Très souvent le nom du tiers (client / fournisseur) |
commentary | Char(500) | Non | Commentaire supplémentaire |
url | Char(2048) | Non | Permet d’ouvrir la facture depuis Fygr si elle est disponible via une URL publique. |
Gestion des échéances multiples (optionnelle)
📖 De manière optionnelle, Fygr permet la gestion des règlements multiples. Dans ce cas, il est possible de nous fournir une troisième type de fichier dit de “règlements”. Ce fichier est unique et peut contenir des règlements concernant à la fois les échéances clients et fournisseurs.
🧾 Les fichiers doivent être nommés : payment_%Y%m%d_%H%M%S .
Champs à renseigner
Nom de la colonne | Format | Obligatoire | Commentaire |
id | Char(100) | Oui | Identifiant technique du règlement dans l’outil partenaire |
date | %Y-%m-%d | Oui | Date du règlement (potentiellement dans le futur) |
amount | Float | Oui | Montant du règlement |
invoice_id | Char(100) | Oui | Identifiant technique de la facture / échéance auquel ce règlement fait référence |
document_type | DocumentEnum | Oui | payable
receivable
Sert à indiquer si le règlement fait référence à une échéance client ou fournisseur |
currency_iso | Char(3) | Oui | Ex : EUR pour l’€, USD pour le $ |
status | StatusEnum | Oui | Les valeurs suivantes sont disponibles : paid
ongoing (en cours, en retard, partiellement payée)
cancelled → facture annulée, plus de paiement attendu.
deleted → supprimée, cas marginal |