Skip to main content

FTP Integration Documentation

Document to be shared with the technician responsible for setting up your FTP connection

S
Written by Support Fygr
Updated over a week ago

🌐 FTP Integration Documentation

📖 To integrate a partner tool with Fygr via FTP, the client must regularly deposit files in a specific format onto our servers. We recommend uploading files daily, around 8:00 PM (French time / CET). Prior to the integration, we will provide the client with SFTP credentials to ensure secure data transfer.

Files to Be Prepared by the Client

File Format

  • Format: .txt or .csv

  • Encoding: UTF-8

  • Delimiter: ;

  • Header row: Yes — column names as documented below

File Naming Convention

🧾 Receivable / 411 / Customer due dates — files must be named: receivable_%Y%m%d_%H%M%S

Example: a customer receivables export generated on July 14, 2025 at 14:33:23 (UTC) must be named receivable_20250714_143323

🧾 Payable / 401 / Supplier due dates — files must be named: payable_%Y%m%d_%H%M%S

Example: a supplier payables export generated on July 14, 2025 at 14:33:23 (UTC) must be named payable_20250714_143323

📖 Depending on your use case, you may upload receivable files, payable files, or both. We recommend using a single consistent timestamp across all files within the same batch upload.

Required Fields

Column Name

Format

Required

Notes

id

Char(100)

Yes

Technical identifier of the invoice in the partner system. Must be unique per invoice.

invoice_number

Char(100)

Yes

Invoice number

issue_date

%Y-%m-%d

Yes

Invoice issue date (e.g. 2025-07-03, not 20250703 or 03/07/2025)

due_date

%Y-%m-%d

Yes

Payment due date

expected_payment_date

%Y-%m-%d

Recommended

Defaults to due_date if not provided

amount

Float

Recommended

Pre-tax amount (e.g. 1103.12, not 1 103,12€)

tax_amount

Float

Recommended

VAT / tax amount

total_amount

Float

Yes

Total amount including tax

currency_iso

Char(3)

Yes

E.g. EUR for €, USD for $

outstanding_amount

Float

Yes

Outstanding balance (remaining amount due)

status

StatusEnum

Yes

Available values: paid

ongoing (in progress, overdue, or partially paid)

cancelled → invoice cancelled, no further payment expected

deleted → removed, edge case

description

Char(500)

Recommended

Typically the name of the counterparty (customer / supplier)

commentary

Char(500)

No

Additional comment

url

Char(2048)

No

Allows the invoice to be opened directly from Fygr if available via a public URL

Managing Multiple Payments (Optional)

📖 Optionally, Fygr supports the management of multiple payment settlements. In this case, a third file type — referred to as a "payments" file — may be provided. This file is a single unified file and may contain payment records relating to both customer and supplier due dates.

🧾 Files must be named: payment_%Y%m%d_%H%M%S

Required Fields

Column Name

Format

Required

Notes

id

Char(100)

Yes

Technical identifier of the payment in the partner system

date

%Y-%m-%d

Yes

Payment date (may be a future date)

amount

Float

Yes

Payment amount

invoice_id

Char(100)

Yes

Technical identifier of the invoice / due date this payment refers to

document_type

DocumentEnum

Yes

payable

receivable — indicates whether the payment refers to a customer or supplier due date

currency_iso

Char(3)

Yes

E.g. EUR for €, USD for $

status

StatusEnum

Yes

Available values: paid

ongoing (in progress, overdue, or partially paid)

cancelled → cancelled, no further payment expected

deleted → removed, edge case

Did this answer your question?